add more file-linking and tidy up some formatting

redbrick · Dec 4, 2023 · 59c0ca2 · 59c0ca2
1 parent bc5df25
commit 59c0ca2
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 14 deletions.
diff --git a/docs/aperture/about.md b/docs/aperture/about.md
@@ -1,7 +1,9 @@
 # Aperture
 
 Aperture is Redbrick's fleet of hardware that was installed in May 2022 by `distro`, `pints`, `skins`, `cawnj`, `ymacomp`
-and `arkues`. It consists of:
+and `arkues`.
+
+It consists of:
 
 - 3x Dell R6515
 
@@ -14,15 +16,15 @@ and `arkues`. It consists of:
 
 ## Servers
 
-The three servers are named `glados`, `wheatley` and `chell`.
+The three servers are named [`glados`](../hosts/glados.md) , [`wheatley`](../hosts/wheatley.md) and [`chell`](../hosts/chell.md).
 
 ## Networks
 
 The firewall is called [`mordor`](firewall.md), and the two 24-port switches are called [`rivendell` and `isengard`](switches.md).
 
 ## Networking
 
-The IP address range for the `aperture` subnet is 10.10.0.0/24, with 10.10.0.0/16 being used for user VMs.
+The IP address range for the [`aperture`](index.md) subnet is `10.10.0.0/24`, with `10.10.0.0/16` being used for user VMs.
 
 | Hostname | Internal Address | External Address | Purpose |
 | -------- | ---------- | -------- | ------- |
@@ -34,29 +36,29 @@ The IP address range for the `aperture` subnet is 10.10.0.0/24, with 10.10.0.0/1
 | `chell` | 10.10.0.6 | 136.206.16.6 | Server |
 
 !!! note
-    Blue cables are used for production network.
+    **Blue** cables are used for **production network**.
 
 ## KVM
 
-`nexus` is the name of the KVM switch. It's internal IP address is 10.10.0.10.
+`nexus` is the name of the KVM switch. It's internal IP address is `10.10.0.10`.
 
-`glados` is connected on port 1, `wheatley` on port 2, and `chell` on port 3.
+[`glados`](../hosts/glados.md) is connected on port 1, [`wheatley`](../hosts/wheatley.md) on port 2, and [`chell`](../hosts/chell.md) on port 3.
 
 !!! note
-    Yellow cables are used for KVM network.
+    **Yellow** cables are used for **KVM network**.
 
 ## IDRAC
 
 The new servers are all equipped with IDRACs. These still need to be configured.
 
-!!! node
-    Red cables are used for IDRAC network.
+!!! note
+    **Red** cables are used for **IDRAC network**.
 
 ## [Images (click me)](images.md)
 
 ## Switching from the old network to the new
 
 We have two address ranges that come in on a single redundant link, so we're exchanging that redundant link for two
-separate links, each taking responsibility for an address range (136.26.15.0/24 and 136.206.16.0/24). So we're surrendering
+separate links, each taking responsibility for an address range (`136.26.15.0/24` and `136.206.16.0/24`). So we're surrendering
 redundancy to gain uptime/connectivity during the switchover only. Once the new servers are production ready, we can
 recombine the link to regain the redundancy.
diff --git a/docs/services/cheatsheet.md b/docs/services/cheatsheet.md
@@ -2,17 +2,17 @@
 
 ## LDAP
 -- Query a user
-```
+```sh
 ldapsearch -x uid="USERNAME_HERE"
 ```
 
 -- Query user as root for more detailed info
-```
+```sh
 ldapsearch -D "cn=root,ou=services,o=redbrick" -y /etc/ldap.secret uid=user
 ```
 
 -- Find all users emails created by `USERNAME`
-```
+```sh
 ldapsearch -x createdby="user" uid | awk '/uid:/ {print $2"@redbrick.dcu.ie"}'
 ```
 
@@ -72,7 +72,7 @@ nix-shell -p [space seperated package names]
 ```
 
 -- Run brickbot2 (running on Metharme)
-```
+```bash
 cd brickbot2
 nix-shell
 source venv/bin/activate