Run prettier, tidy spelling warnings

The troubleshooting pages don't format cleanly without losing function,
but let's format everything else

Author: davidjharder

.cspell-allowed-words.txt

@@ -269,6 +269,8 @@ nopatch
 noprefixroute
 nproc
 nuitka
+numlock
+numlockx
 nvme
 ocen
 ocenaudio

docs/packaging/appstream-metainfo.md

@@ -32,8 +32,8 @@ There are a few scenarios that Packagers might encounter:
 | 1   | An application already provides appstream metainfo                                               | Nothing to do                                                                                                                                                                                                                |
 | 2   | An application contains appstream metainfo in the source package but we do not install it        | Install the appstream metainfo to `/usr/share/metainfo`. _Example_: [here](https://github.com/getsolus/packages/commit/0a726a53454e7c8a6b0e66de69d59bcc66f0fc19)                                                             |
 | 3   | An application doesn't contain appstream metainfo in the source package but it exists on Flathub | Borrow and tweak the appstream metainfo from the Flathub repo. Encourage upstream project to add it to their source. _Example_: [here](https://github.com/getsolus/packages/commit/da2f65b93f412da43d1db9edbcb08bb90517a0eb) |
-| 4   | An application doesn't provide appstream metainfo and it doesn't exist on flathub                | See [here](#writing-appstream-metainfo). _Example_: [here](https://github.com/getsolus/packages/commit/414219d8b2ceeabe85178d3a467f81b9131016f4)                                                         |
-| 5   | Appstream metainfo is provided but composition of it is failing                                   | See [here](#testing-appstream-metainfo). _Example_: [here](https://github.com/getsolus/packages/commit/583b7c742caf50e2f66a70e9b62e9b91566c03f5).                                    |
+| 4   | An application doesn't provide appstream metainfo and it doesn't exist on flathub                | See [here](#writing-appstream-metainfo). _Example_: [here](https://github.com/getsolus/packages/commit/414219d8b2ceeabe85178d3a467f81b9131016f4)                                                                             |
+| 5   | Appstream metainfo is provided but composition of it is failing                                  | See [here](#testing-appstream-metainfo). _Example_: [here](https://github.com/getsolus/packages/commit/583b7c742caf50e2f66a70e9b62e9b91566c03f5).                                                                            |
 
 AppStream metainfo is to be installed in the `/usr/share/metainfo/` directory. It must be placed in the package which should be installed in order to get the software described by the respective metadata. This means that you might need to move the _.metainfo.xml or _.appdata.xml to the right (sub)package.
 
@@ -55,15 +55,14 @@ In case your AppStream metainfo is describing a desktop application (you can tel
 
 - Run a report against the extracted install directory.
 
-
   For general testing, the following command should be sufficient:
 
   ```bash
   appstreamcli compose install/ --hints-dir=hints --verbose
   ```
 
   For more advanced testing, such as media generation, e.g. to test font screenshots get auto-generated, run:
-  
+
   ```bash
   appstreamcli compose install/ --hints-dir=hints --media-dir=media --media-baseurl=localhost:8000 --verbose
   ```
@@ -80,7 +79,7 @@ The `appstreamcli compose` tool will normally give good hints about failures but
 
 - A `.desktop` file cannot be matched to the metainfo file.
   - By default, the `.desktop` file name must match the `<id>` provided in `.xml` file in `/usr/share/metainfo/`. For example, the if you have `<id>org.foobar.my_package</id>` the `.desktop` file should be called `org.foobar.my_package.desktop`. However, there is an exception to this if the metainfo provides a launchable tag. For example, if the metainfo contains `<launchable type="desktop-id">my_package.desktop</launchable>` then the `.desktop` file can be just called `my_package.desktop`. For more information view the upstream documentation [here](https://www.freedesktop.org/software/appstream/docs/sect-Metadata-Application.html#spec-appdata-introduction).
-- No metainfo file is provided. 
+- No metainfo file is provided.
   - No appstream metainfo was found in `/usr/share/metainfo/`.
   - Appstream metainfo may exist in `/usr/share/appdata/` but that path is now obsolete and is no longer read from.
 - No icon found.
@@ -111,19 +110,20 @@ It is not necessary to pass all pedantic warnings, but all errors must be rectif
 To generate a catalog with appstream generator, a `asgen-config.json` file must be provided.
 
 Here is a example configuration file for running against local repositories.
+
 ```json
 {
-    "ProjectName": "Solus",
-    "ArchiveRoot": "/var/lib/solbuild",
-    "MediaBaseUrl": "http://localhost:8000/export/media",
-    "HtmlBaseUrl": "http://localhost:8000/export/html",
-    "Backend": "solus",
-    "Suites": {
-        "local": {
-            "sections": ["main"],
-            "architectures": ["x86_64"]
-        }
+  "ProjectName": "Solus",
+  "ArchiveRoot": "/var/lib/solbuild",
+  "MediaBaseUrl": "http://localhost:8000/export/media",
+  "HtmlBaseUrl": "http://localhost:8000/export/html",
+  "Backend": "solus",
+  "Suites": {
+    "local": {
+      "sections": ["main"],
+      "architectures": ["x86_64"]
     }
+  }
 }
 ```
 
@@ -134,25 +134,26 @@ To generate the catalog run `appstream-generator run local --verbose`. Depending
 To view the HTML report, you can start a http server with `python3 -m http.server 8000`, enter `http://localhost:8000/` in your web browser, then navigate to `export/html/`.
 
 It can also be ran against a remote repository, here is a sample configuration.
+
 ```json
 {
-    "ProjectName": "Solus",
-    "ArchiveRoot": "https://fastly.getsol.us/repo",
-    "MediaBaseUrl": "https://appstream.getsol.us/media",
-    "HtmlBaseUrl": "https://appstream.getsol.us",
-    "Backend": "solus",
-    "Suites": {
-        "gwendraeth": {
-            "sections": ["main"],
-            "architectures": ["x86_64"]
-        },
-        "gwendraeth-updates": {
-            "sections": ["main"],
-            "architectures": ["x86_64"],
-            "dataPriority": 10,
-            "baseSuite": "gwendraeth"
-        }
+  "ProjectName": "Solus",
+  "ArchiveRoot": "https://fastly.getsol.us/repo",
+  "MediaBaseUrl": "https://appstream.getsol.us/media",
+  "HtmlBaseUrl": "https://appstream.getsol.us",
+  "Backend": "solus",
+  "Suites": {
+    "gwendraeth": {
+      "sections": ["main"],
+      "architectures": ["x86_64"]
+    },
+    "gwendraeth-updates": {
+      "sections": ["main"],
+      "architectures": ["x86_64"],
+      "dataPriority": 10,
+      "baseSuite": "gwendraeth"
     }
+  }
 }
 ```
 

docs/packaging/monitoring.yaml.md

@@ -25,6 +25,7 @@ To add a `monitoring.yaml` file to an existing package you can use the following
 `go-task add-monitoring` will automatically fill all the fields if a match is found on [release-monitoring.org](https://release-monitoring.org) and [cpe-guesser.cve-search.org](https://cpe-guesser.cve-search.org).
 
 :::
+
 ```bash
 go-task add-monitoring
 ```

docs/packaging/package.yml.md

@@ -165,7 +165,7 @@ Macros are prefixed with `%`, and are substituted before your script is executed
 | **%apply_patches**            | Applies all patches listed in the `series` file in `./files` folder.                                                                      |
 | **%reconfigure**              | Updates build scripts such as `./configure` and proceeds to run `%configure`.                                                             |
 | **%symlink_check**            | Checks for broken symlinks in the install directory and aborts the build if any are found. Must run after install macros.                 |
-| **%install_license**          | Installs any files after the macro to `$installdir/usr/share/licenses/$package/`. |
+| **%install_license**          | Installs any files after the macro to `$installdir/usr/share/licenses/$package/`.                                                         |
 
 ### Haskell actionable macros
 

docs/packaging/packaging-changes.md

@@ -19,6 +19,7 @@ This page is meant to serve as a changelog of sorts for the Solus packaging envi
 
 - Packages must now have license files installed so we are compliant.
 - License files can be easily installed with the new `%install_license` macro.
+  <!-- prettier-ignore -->
   ```yaml
   install    : |
       %ninja_install

docs/packaging/packaging-practices.md

@@ -92,6 +92,7 @@ All new packages or updates to packages should abide by the [SPDX 3.x](https://s
 
 License files that are present in an upstream project must also be installed with the package. This can be easily done with the `%install_license` macro. The macro will install any files passed to it to the system licenses directory, `$installdir/usr/share/licenses/$package/`. The files passed to the macro are expected to be relative to the project's source root.
 
+<!-- prettier-ignore -->
 ```yaml
 install    : |
     %ninja_install

docs/packaging/updating-an-existing-package.md

@@ -18,7 +18,7 @@ This PR resolves software update request https://github.com/getsolus/packages/is
 ```
 
 **Also check to see if there's already an active maintainer**
-If there's a MAINTAINER.md file, see [this](https://help.getsol.us/docs/packaging/procedures/maintainership). 
+If there's a MAINTAINER.md file, see [this](https://help.getsol.us/docs/packaging/procedures/maintainership).
 Please contact the maintainer listed in that file, or [create a package update request](https://github.com/getsolus/packages/labels/Package%3A%20Update%20Request) before attempting to update the package.
 
 :::

docs/user/editions/budgie/tips-and-tricks.md

@@ -47,6 +47,6 @@ Numlock can then be enabled or disabled via a toggle switch on the _Settings_ ta
 
 **Note:** in the Budgie Menu, you can find `lightdm-settings` as System Tools > Login Window.
 
-----------
+---
 
 > TODO: There's got to be more that we can add here

docs/user/quick-start/boot-management.md

@@ -28,7 +28,7 @@ To make the boot menu appear automatically with a five-second timeout:
 
 ## Add kernel parameters
 
-You can add kernel parameters by creating configuration files that `clr-boot-manager` uses when updating kernels. 
+You can add kernel parameters by creating configuration files that `clr-boot-manager` uses when updating kernels.
 
 To add kernel parameters, do the following:
 
@@ -50,7 +50,7 @@ To add kernel parameters, do the following:
    echo 'nomodeset' | sudo tee /etc/kernel/cmdline.d/40_nomodeset.conf
    ```
 
-1. If you want to add multiple parameters, put them on one line with spaces between them in the configuration file. 
+1. If you want to add multiple parameters, put them on one line with spaces between them in the configuration file.
 
    For example:
 

docs/user/quick-start/kernel-management/add-new-kernels.md

@@ -10,18 +10,17 @@ By default, Solus uses the `linux-current` kernel. You can switch between kernel
 To install and switch to a different kernel branch, follow these steps:
 
 1. Install the desired kernel branch:
-
    - Current kernel
 
      ```
-	  sudo eopkg install linux-current
-	  ```
+     sudo eopkg install linux-current
+     ```
 
    - LTS kernel
-	 
-	  ```
-	  sudo eopkg install linux-lts
-	  ```
+
+     ```
+     sudo eopkg install linux-lts
+     ```
 
 1. Install the necessary kernel modules of the kernel branch you want to try.
 
@@ -52,7 +51,7 @@ To install and switch to a different kernel branch, follow these steps:
    :::warning Important
 
    On systems with UEFI installations, the boot menu doesn't appear by default.
-   
+
    To display the boot menu, press the <kbd>Space bar</kbd> key repeatedly as your computer starts.
 
    :::