docs: various small fixes (#424)

Signed-off-by: Thomas Staudinger <[email protected]>

docs/packaging/advanced-config/eopkg-configuration.md

@@ -11,7 +11,7 @@ The eopkg configuration file changes how eopkg works. The first section in the c
 
 Solus aims to be a stateless operating system, so the default configuration file for eopkg is saved to `/usr/share/defaults/eopkg/eopkg.conf`. To modify the configuration, you'll have to start by copying the default configuration file into `/etc/eopkg` so it will override the default file:
 
-```sh
+```bash
 sudo mkdir -p /etc/eopkg && sudo cp /usr/share/defaults/eopkg/eopkg.conf /etc/eopkg/eopkg.conf
 ```
 

docs/packaging/advanced-config/local-repository.md

@@ -19,7 +19,7 @@ We assume you have worked through the [packaging](/docs/packaging) material for
 sudo eopkg install solbuild-config-local-unstable
 ```
 
-You will also need to ensure that your common directory is fully up to date. Run `git pull` from within the common directory to receive the latest updates.
+You will also need to ensure that your repository is fully up to date. See [Update Your Development Environment](/docs/packaging/update-dev-environment.md)
 
 ## Utilising the local repository
 
@@ -29,7 +29,7 @@ Improvements have been made to make it simple for contributors to test fixes out
 
 Note that you will need both the regular package and the `-devel` package if you want to build another package against them using `pkgconfig()` in the `package.yml file`.
 
-With the `.eopkg` files now present in the local repo, we can make use of them in solbuild by running `go-task build-local` rather than just  `go-task`. This will index the local repository and prioritise their use over what is available in the Solus unstable repository.
+With the `.eopkg` files now present in the local repo, we can make use of them in solbuild by running `go-task build-local` rather than just `go-task`. This will index the local repository and prioritise their use over what is available in the Solus unstable repository.
 
 ## Best practices when working with a solbuild local repository
 
@@ -52,7 +52,9 @@ As mentioned earlier, the local solbuild repo installed by the `solbuild-config-
 
 To generate or refresh the eopkg index in `/var/lib/solbuild/local`, simply run:
 
-`sudo eopkg index --skip-signing /var/lib/solbuild/local/ --output /var/lib/solbuild/local/eopkg-index.xml`
+```bash
+sudo eopkg index --skip-signing /var/lib/solbuild/local/ --output /var/lib/solbuild/local/eopkg-index.xml
+```
 
 ### A note on package resolution priority
 
@@ -77,7 +79,7 @@ Solus [active]
 
 Now the repositories need to be added to account for the desired dependency resolution order:
 
-```
+```bash
 sudo eopkg ar Local /var/lib/solbuild/local/eopkg-index.xml.xz
 sudo eopkg ar Solus https://cdn.getsol.us/repo/unstable/eopkg-index.xml.xz
 ```

docs/packaging/packaging-changes.md

@@ -17,16 +17,13 @@ This page is meant to serve as a changelog of sorts for the Solus packaging envi
 
 #### Git hooks
 
-Run `go-task init` to initialize Git hooks for the packages repository.
-See [Prepare for packaging](prepare-for-packaging.md#initialize-git-hooks).
+- Run `go-task init` to initialize Git hooks for the packages repository. See [Prepare for packaging](prepare-for-packaging.md#initialize-git-hooks).
 
 #### Requiring `homepage` in `package.yml`
 
 - The `homepage` key in `package.yml` has become mandatory. Use the address to the upstream source repository (eg: the GitHub page) if a package does not have a homepage.
 - This is enforced by checks on all pull requests.
 
-### October
-
 #### Recommending amending commits in Pull Requests
 
 - Amending commits and force pushing the changes works better with our build tooling.
@@ -39,7 +36,7 @@ See [Prepare for packaging](prepare-for-packaging.md#initialize-git-hooks).
 - All packaging actions are now handled by `go-task` rather than `make`.
   - Building a package can be done using `go-task` rather than `make`.
   - Commands are the same: `make local`, for example, is replaced by `go-task local`.
-  - You can see all available commands by either browsing to `Taskfile.yml` in the `packages` repo at [`common/Taskfile.yml`](https://github.com/getsolus/packages/blob/main/common/Taskfile.yml) OR running `go-task -l` somewhere in your updated clone of the packages git monorepo.
+  - You can see all available commands by either browsing to `Taskfile.yml` in the [`packages` repo](https://github.com/getsolus/packages/blob/main/Taskfile.yml) OR running `go-task -l` somewhere in your updated clone of the packages git monorepo.
 - Packagers should install `go-task` on their machines if they have not already.
 - The `Makefile` included with every package is no longer required. Please delete it from a package when updating, and do not include it when making the initial commit of a new package.
 

docs/packaging/prepare-for-packaging.md

@@ -110,14 +110,14 @@ ln -s ~/solus-packages/common/Scripts/helpers.sh ~/.bashrc.d/solus-monorepo-help
 
 ### fish
 
-```fish
+```bash
 mkdir -p ~/.config/fish/conf.d
 ln -s ~/solus-packages/common/Scripts/helpers.fish ~/.config/fish/conf.d/solus.fish
 ```
 
 ### zsh
 
-```zsh
+```bash
 mkdir -p ~/.zshrc.d
 printf "\nfpath=(~/.zshrc.d \$fpath)" >> ~/.zshrc
 source ~/.zshrc

docs/packaging/your-first-package-update.md

@@ -23,7 +23,7 @@ Switch to the directory containing the `nano` recipe:
 cd packages/n/nano
 ```
 
-Alternatively, if you've set up the [Monorepo Helper Functions](docs/packaging/prepare-for-packaging#set-up-monorepo-helper-functions-optional) you can replace the above to steps by these simple commands:
+Alternatively, if you've set up the [Monorepo Helper Functions](/docs/packaging/prepare-for-packaging#set-up-monorepo-helper-functions-optional) you can replace the above to steps by these simple commands:
 
 ```bash
 gotosoluspkgs

docs/user/contributing/getting-involved.md

@@ -20,7 +20,7 @@ With so many new users joining, there are always more people needing help. A gre
 ### [Matrix](/docs/user/contributing/getting-involved#matrix-chat) (chat)
 
 [Matrix](<https:/.wikipedia.org/wiki/Matrix_(protocol)>) is a great way to discuss issues and development with the community, and project developers in real-time. It's also a great place for getting support, but remember due
-to timezone differences there might not always be people there to answer your question immediately. You can access Matrix using a client like [Element Web](https://app.element.io/), or many [others](https://matrix.org/clients/). You will need a Matrix account.
+to timezone differences there might not always be people there to answer your question immediately. You can access Matrix using a client like [Element Web](https://app.element.io/), or many [others](https://matrix.org/ecosystem/clients/). You will need a Matrix account.
 
 You will find the following Solus rooms on the `matrix.org` homeserver:
 

docs/user/contributing/testing-an-iso.md

@@ -18,7 +18,7 @@ When testing, try to keep different types of users in mind. For instance, would
 - Install your usual software and just make sure basic functionality works
 - Plugging in a USB drive allows user to mount the drive and access files
 - System can be put to sleep and woken, things still work after waking (display, keyboard, mouse, sound, network)
-- Able to create and use samba shares via file manager (you must [enable smb after installation](https://help.getsol.us/docs/user/software/networking/samba#samba-on-solus))
+- Able to create and use samba shares via file manager (you must [enable smb after installation](/docs/user/software/networking/samba.md#samba-on-solus))
 - Anything that's been flaky in your experience (LVM, for instance)
 
 ### Laptops

docs/user/intro.md

@@ -18,7 +18,7 @@ If you've never used Solus before, this section will set you on the right track.
 
 **[Editions](/docs/user/editions/)**
 
-Solus comes in multiple Editions for different Desktop Environments. The purpose of this section is to introduce you to those desktops, walk you through common configuration tasks, and provides useful tips and tricks.
+Solus comes in multiple editions for different desktop environments. The purpose of this section is to introduce you to those desktops, walk you through common configuration tasks, and provide useful tips and tricks.
 
 **[Hardware](/docs/user/hardware/)**
 
@@ -43,7 +43,7 @@ Our Flarum-powered forums are easy to use from any device and are a great resour
 **[Matrix](https://matrix.to/#/#solus:matrix.org)**
 
 [Matrix](<https://en.wikipedia.org/wiki/Matrix_(protocol)>) is a great way to discuss issues and development with the community, and project developers in real-time. It's also a great place for getting support, but remember due
-to timezone differences there might not always be people there to answer your question immediately. You can access [Matrix](/docs/user/contributing/getting-involved.md#matrix-chat) using a client like [Element Web](https://app.element.io/), or many [others](https://matrix.org/clients/). You will need a [Matrix](/docs/user/contributing/getting-involved.md#matrix-chat) account.
+to timezone differences there might not always be people there to answer your question immediately. You can access [Matrix](/docs/user/contributing/getting-involved.md#matrix-chat) using a client like [Element Web](https://app.element.io/), or many [others](https://matrix.org/ecosystem/clients/). You will need a [Matrix](/docs/user/contributing/getting-involved.md#matrix-chat) account.
 
 Read more about Solus on Matrix [here.](/docs/user/contributing/getting-involved.md#matrix-chat)
 

docs/user/package-management/basics.md

@@ -40,7 +40,7 @@ sudo eopkg install --reinstall gnome-documents gnome-music
 
 You can uninstall one or more packages by using:
 
-```
+```bash
 sudo eopkg remove packagename
 ```
 
@@ -55,13 +55,13 @@ sudo eopkg remove gnome-documents gnome-music
 You can get information on software, such as its description, version, installation size, and more, by using
 
 ```bash
-sudo eopkg info packagename
+eopkg info packagename
 ```
 
 For example:
 
 ```bash
-sudo eopkg info gnome-documents
+eopkg info gnome-documents
 ```
 
 ## Updating
@@ -83,13 +83,13 @@ sudo eopkg upgrade firefox
 You can search the software selection Solus provides by using:
 
 ```bash
-sudo eopkg search term
+eopkg search term
 ```
 
 For example:
 
 ```bash
-sudo eopkg search documents
+eopkg search documents
 ```
 
 Notice that you don't need to search for a specific software name, although you can do that. We search summaries and software names by default.

docs/user/package-management/history-and-rollback.md

@@ -14,7 +14,7 @@ Our rollback feature allows you to essentially rewind your system's software bac
 You can see the history from eopkg by using:
 
 ```bash
-sudo eopkg history
+eopkg history
 ```
 
 ## Rollback

docs/user/package-management/repo-management.md

@@ -11,10 +11,10 @@ While Solus currently only provides two repositories, stable (shannon) and unsta
 
 The official Solus repositories are:
 
-| Repository       | URL                                                      | Notes                                                                                                                                                |
-| ---------------- | -------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Stable (shannon) | `https://cdn.getsol.us/repo/shannon/eopkg-index.xml.xz`  | This is the default repository.                                                                                                                      |
-| Unstable         | `https://cdn.getsol.us/repo/unstable/eopkg-index.xml.xz` | This repository should only be used if you intend to build Solus packages or to test new packages before they are synced to the _stable_ repository. |
+| Repository           | URL                                                      | Notes                                                                                                                                                |
+| -------------------- | -------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **Stable (shannon)** | `https://cdn.getsol.us/repo/shannon/eopkg-index.xml.xz`  | This is the default repository.                                                                                                                      |
+| **Unstable**         | `https://cdn.getsol.us/repo/unstable/eopkg-index.xml.xz` | This repository should only be used if you intend to build Solus packages or to test new packages before they are synced to the _stable_ repository. |
 
 :::danger
 
@@ -101,5 +101,5 @@ sudo eopkg update-repo Example
 You can list all the repositories added on your system by using:
 
 ```bash
-sudo eopkg list-repo
+eopkg list-repo
 ```

docs/user/quick-start/default-applications.md

@@ -9,13 +9,13 @@ Each version of Solus comes with a pre-installed collection of desktop applicati
 
 # Web Browser
 
-Solus comes pre-installed with Firefox, a secure and trustworthy web browser provided by the non-profit organization [Mozilla](https://www.mozilla.org-US/).
+Solus comes pre-installed with Firefox, a secure and trustworthy web browser provided by the non-profit organization [Mozilla](https://www.mozilla.org/).
 
 ![Firefox Screenshot](default-applications/firefox.jpg)
 
 # Email Client
 
-Solus comes pre-installed with the powerful [Thunderbird](https://www.mozilla.org-US/thunderbird/) email, newsgroup, and feeds client.
+Solus comes pre-installed with the powerful [Thunderbird](https://www.mozilla.org/thunderbird/) email, newsgroup, and feeds client.
 
 ![Thunderbird Screenshot](default-applications/thunderbird.jpg)
 
@@ -48,7 +48,7 @@ Each Linux desktop environment has its own graphical application for managing fi
 
 # Office Suite
 
-Solus comes pre-installed with [LibreOffice](https://libreoffice.org), an office suite that is capable of replacing Microsoft<sup>TM</sup> Office for the most common tasks.
+Solus comes pre-installed with [LibreOffice](https://www.libreoffice.org), an office suite that is capable of replacing Microsoft<sup>TM</sup> Office for the most common tasks.
 
 By default, Solus provides Writer (document editor), Calc (spreadsheet editor), and Impress (presentation editor). Other applications such as Math or Draw can be installed from the Software Center.
 

docs/user/quick-start/installation/secure-boot.md

@@ -39,7 +39,7 @@ Now, with the Solus certificate enrolled, press `Enter` to reboot the machine, b
 
 If you already have Solus installed and wish to enable secure boot then there is one extra step you must perform BEFORE continuing with [Enrolling the Solus Certificate](#enrolling-the-solus-certificate) as normal.
 
-Firstly, you must confirm you have `clr-boot-manager, version: 3.2.12, release: 29` installed, run `eopkg info clr-boot-manager` to confirm this. This version of `clr-boot-manager` will have created a new UEFI boot entry on your machine called `Solus Linux Bootloader` that can be booted from with Secure Boot enabled.
+Firstly, you must confirm you have `clr-boot-manager, version: 3.2.12, release: 29` (or later) installed, run `eopkg info clr-boot-manager` to confirm this. This version of `clr-boot-manager` will have created a new UEFI boot entry on your machine called `Solus Linux Bootloader` that can be booted from with Secure Boot enabled.
 
 :::note Before continuing, it is important to note the screenshots provided here are for example only, your UEFI firmware interface will almost certainly look different.
 :::
@@ -87,6 +87,6 @@ As such, we are not currently looking to our get our own `shim` signed by Micros
 
 ## Useful Links for Additional Reading
 
-- https://learn.microsoft.com-us/windows-hardware/drivers/dashboard/file-signing-reqs
+- https://learn.microsoft.com/windows-hardware/drivers/dashboard/file-signing-reqs
 - https://github.com/rhboot/shim-review/
 - https://github.com/rhboot/shim/