Merge pull request #19 from redbrick/cleanup-2

cleanup: syntax and add callouts

docs/services/bind.md

@@ -1,13 +1,12 @@
 # Bind9 - `distro`, `ylmcc`
 
-Bind9 is our DNS provider. Currently it runs on [paphos](../hosts/paphos.md), but is being moved to Fred during the restructuring.
+Bind9 is our DNS provider. Currently it runs on [`paphos`](../hosts/paphos.md), but this may change in the near future.
 
 ## Configuration
 
-The config files for bind are located in `/etc/bind/master/`. The most important file in this directory is the
-`db.Redbrick.dcu.ie` file.
+The config files for bind are located in `/etc/bind/master/`. The most important file in this directory is the `db.Redbrick.dcu.ie` file.
 
-!!! note
+> [!WARNING] Note
 > You must never update this file without following the steps below first!
 
 ## Updating DNS
@@ -16,12 +15,12 @@ To update DNS:
 
 1. Change directory to `/etc/bind/master`
 2. Back up the `db.Redbrick.dcu.ie` file, usually to `db.Redbrick.dcu.ie.bak`
-3. Run `rndc freeze redbrick.dcu.ie` - this stops changes to the file affecting dns while you edit it
+3. Run `rndc freeze redbrick.dcu.ie` - this stops changes to the file affecting DNS while you edit it
 4. Edit `db.Redbrick.dcu.ie`
 5. Before changing any DNS entry in the file, you **must** edit the serial number on 4. You can increment it by one if
 you want, or follow the format: `YYYYMMDDrev` where rev is revision
 6. Once you are happy with your file, you can check it with `named-checkzone redbrick.dcu.ie db.Redbrick.dcu.ie`
 7. If this returns no errors, you are free to run `rndc thaw redbrick.dcu.ie`
-8. Check the status of bind9 by running `service bind9 status`
+8. Check the status of `bind9` by running `service bind9 status`
 
-You can access more logs from bind9 by checking `/var/log/named/default.log`.
+You can access more logs from `bind9` by checking `/var/log/named/default.log`.

docs/services/codimd.md

@@ -4,7 +4,7 @@ CodiMD lives on [`zeus`](../hosts/zeus.md) as a docker container. It is accessib
 
 CodiMD is built locally and is based on [codimd](https://github.com/hackmdio/CodiMD), the docs for which are [here](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-docker-deployment).
 
-Hackmd auths against LDAP and its configuration is controlled from docker-compose. Go to `/etc/docker-compose/services/hackmd` on [zeus](../hosts/zeus.md) to find the configuration.
+Hackmd auths against LDAP and its configuration is controlled from docker-compose. Go to `/etc/docker-compose/services/hackmd` on [`zeus`](../hosts/zeus.md) to find the configuration.
 
 See [CodiMD github](https://github.com/hackmdio/hackmd/#environment-variables-will-overwrite-other-server-configs) for more info on configuration. 
 The important points are disabling anonymous users and the LDAP settings.

docs/services/servers.md

@@ -21,11 +21,11 @@ ssh [email protected] -i SSH_KEY_LOCATION_PATH
 # NOTE: The "-i" flag specifies the location of your private ssh key.
 ```
 
-##### Alternatives
+### Alternatives
 
 If you are an unbothered king/queen that simply does not mind using a web interface, let me introduce you to [wetty.redbrick.dcu.ie](https://wetty.redbrick.dcu.ie/). You do not need an SSH key here.
 
-##### Logging in to other servers
+### Logging in to other servers
 
 Your home directory is synced (i.e the same) on all public Redbrick servers. Thus the `authorized_keys` file will be the same on [Azazel](../hosts/azazel.md) as it is on [Pygmalion](../hosts/pygmalion.md), meaning you can log in to `pyg.redbrick.dcu.ie` too, and so on.
 
@@ -62,7 +62,8 @@ Enter passphrase (empty for no passphrase):
 ```
 Here you may protect this key file with a passphrase. This is optional and recommended for security.
 
-    *If you do not wish to add a passphrase to save you all that typing, simply press <kbd>ENTER</kbd> for the password and confirmation password prompts.*
+> [!NOTE] Note
+> *If you do not wish to add a passphrase to save you all that typing, simply press <kbd>ENTER</kbd> for the password and confirmation password prompts.*
 
 *The newly generated public key should now be saved* in `/home/bob/.ssh/id_ed25519.pub`. The private key is the same file is at `/home/bob/.ssh/id_ed25519`. *(i.e under the `.ssh` folder in your user home directory.)*
 

docs/services/znapzend.md

@@ -33,8 +33,8 @@ root SSH key is working.
 If the NFS server is online and functional, you do not need to involve Albus to roll back changes, as all the snapshots
 are kept on Icarus too.
 
-  1. Find the snapshot you want to restore with zfs list -t snapshot.
-  2. Run zfs rollback $snapshotname.
+  1. Find the snapshot you want to restore with `zfs list -t snapshot`.
+  2. Run `zfs rollback $snapshotname`.
 
 That's it! These instructions obviously work for backups other than NFS too, should any ever exist.