repo-wide: Some minor fixes (#560)

- Package YAML: Adjust line numbers for CONFOPTS - Package YAML: Fix sourceforge URL example - History and Software Rollback: Remove unnecessary sudo - System Requirements: Format units as recommended by style guide, unify format of "x86-64" - Secure Boot: Unify spelling of "Secure Boot" - Community Guidelines: Use "Solus" instead of "Solus Project" - Getting Involved: Use "Solus" instead of "Solus Project" - Run yarn prettier Signed-off-by: Thomas Staudinger <[email protected]>
getsolus · Sep 13, 2024 · 98e04e6 · 98e04e6
1 parent 28fd342
commit 98e04e6
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 41 deletions.
diff --git a/docs/packaging/package.yml.md b/docs/packaging/package.yml.md
@@ -77,9 +77,9 @@ Not all fields in `package.yml` are mandatory, but a small selection are. Below
   - Example: `https://github.com/docker/cli/archive/refs/tags/v25.0.3.tar.gz#docker-cli.tar.gz : 04ad0cea992a65db20cb1b0dbf6d1ce32c705ce879de51b22095fe8d28030815`
   - This renames the downloaded file from `v25.0.3.tar.gz` to `docker-cli.tar.gz`.
 - SourceForge sources
-  - A proper SourceForge source looks like this, using `hplip` as an example: `https://downloads.sourceforge.net/project/hplip/hplip/3.24.4/hplip-3.24.4.tar.gz`
+  - A proper SourceForge source looks like this, using `hplip` as an example: `https://sourceforge.net/projects/hplip/files/hplip/3.24.4/hplip-3.24.4.tar.gz`
     - This URL begins with `https://sourceforge.net/`, not `https://downloads.sourceforge.net/`, or some other mirror.
-    - This URL has a path beginning with `/project/$project_name/`
+    - This URL has a path beginning with `/projects/$project_name/`
     - This URL does _not_ have a trailing `/download`, you may have to remove this by hand.
   - The correct SourceForge tarball URLs are found under the "Files" tab, then often within a directory, when starting from a project homepage on SourceForge.
 
@@ -257,7 +257,7 @@ BOLT is a post-link optimizer developed to speed up large applications. You will
 | **%ARCH%**                   | Indicates the current build architecture.                                                                                                         |
 | **%CC%**                     | C compiler.                                                                                                                                       |
 | **%CFLAGS%**                 | cflags as set in `eopkg.conf`.                                                                                                                    |
-| **%CONFOPTS%**               | Flags / options for configuration, such as `--prefix=%PREFIX%`. [Full List.](https://github.com/getsolus/ypkg/blob/master/ypkg2/rc.yml#L431-L443) |
+| **%CONFOPTS%**               | Flags / options for configuration, such as `--prefix=%PREFIX%`. [Full List.](https://github.com/getsolus/ypkg/blob/master/ypkg2/rc.yml#L444-L456) |
 | **%CXX%**                    | C++ compiler.                                                                                                                                     |
 | **%CXXFLAGS%**               | cxxflags as set in `eopkg.conf`.                                                                                                                  |
 | **%JOBS%**                   | jobs, as set in `eopkg.conf`.                                                                                                                     |

diff --git a/docs/user/contributing/community-guidelines.md b/docs/user/contributing/community-guidelines.md
@@ -5,7 +5,7 @@ summary: Community Guidelines
 
 # Community guidelines
 
-The Solus Project enforces a set of community guidelines to maintain a family-friendly, respectful, and professional environment.
+Solus enforces a set of community guidelines to maintain a family-friendly, respectful, and professional environment.
 
 Our guidelines apply to all services offered or used by the project, in addition to any terms of service of third-party services used by the project. Solus Staff reserves the right to either ban or terminate access, on a temporary or permanent basis, to members of the community which are found to be violating our guidelines.
 

diff --git a/docs/user/contributing/getting-involved.md b/docs/user/contributing/getting-involved.md
@@ -11,11 +11,11 @@ Solus is a big undertaking, and as such there are many ways in which your involv
 
 ### Community guidelines
 
-The Solus Project enforces a set of community guidelines to maintain respect and professionalism, as well as a family-friendly environment. Please view our community guidelines [here](/docs/user/contributing/community-guidelines).
+Solus enforces a set of community guidelines to maintain respect and professionalism, as well as a family-friendly environment. Please view our community guidelines [here](/docs/user/contributing/community-guidelines).
 
 ### Community forums
 
-With so many new users joining, there are always more people needing help. A great way to help us out, would be to help out our users on the [Solus Project Forums](https://discuss.getsol.us).
+With so many new users joining, there are always more people needing help. A great way to help us out, would be to help out our users on the [Solus Forums](https://discuss.getsol.us).
 
 ### Matrix (chat)
 
@@ -54,7 +54,7 @@ and contribute to the community by packaging software. If you're interested in l
 
 ## Report bugs
 
-We're always looking to improve our systems, especially when they're not functioning as expected. By reporting bugs, you improve the system not only for you, but for all Solus Project users.
+We're always looking to improve our systems, especially when they're not functioning as expected. By reporting bugs, you improve the system not only for you, but for all Solus users.
 
 - [Main Solus GitHub Issue Tracker](https://issues.getsol.us)
   Most bug reports about Solus itself, and its packages, should be filed here.

diff --git a/docs/user/package-management/history-and-rollback.md b/docs/user/package-management/history-and-rollback.md
@@ -5,21 +5,21 @@ summary: History and Software Rollback
 
 # History and software rollback in Solus
 
-Solus offers a feature to view your history of software changes and revert your system to previous versions. 
+Solus offers a feature to view your history of software changes and revert your system to previous versions.
 
 You can use this feature if you have issues after installing packages or system updates, and you need to return to a working state.
 
 ## History of software changes
 
 - To see your history of software changes, open a terminal and execute:
 
-    ```bash
-    eopkg history
-    ```
+  ```bash
+  eopkg history
+  ```
 
-    The terminal displays a list of all the software changes in your system.
+  The terminal displays a list of all the software changes in your system.
 
-    ![eopkg history output](./eopkg-history-output.png)
+  ![eopkg history output](./eopkg-history-output.png)
 
 ## Rollback
 
@@ -34,26 +34,26 @@ Reverting software changes works if either:
 
 1. Disable any [local repository](https://help.getsol.us/docs/packaging/advanced-config/local-repository#disabling-the-local-solbuild-repository-in-eopkg) you have.
 
-    Local repositories can cause errors during rollbacks.
+   Local repositories can cause errors during rollbacks.
 
 1. Open a terminal.
 
 1. View the history of software changes:
 
-    ```bash
-    sudo eopkg history
-    ```
+   ```bash
+   eopkg history
+   ```
 
 1. Note the number of the most recent software change.
 
 1. Go back to the desired state:
 
-    ```bash
-    sudo eopkg history -t NUMBER
-    ```
+   ```bash
+   sudo eopkg history -t NUMBER
+   ```
 
-    Replace `NUMBER` with a number lower than the latest software change.
+   Replace `NUMBER` with a number lower than the latest software change.
 
-    For example, if you want to revert operation 100, use 99 as the number.
+   For example, if you want to revert operation 100, use 99 as the number.
 
-After reverting to the desired state, verify your system status. You might need to restart your system to see some of the changes.
+After reverting to the desired state, verify your system status. You might need to restart your system to see some of the changes.
diff --git a/docs/user/package-management/repo-management.md b/docs/user/package-management/repo-management.md
@@ -27,6 +27,7 @@ Before updating, check the [#solus-packaging](https://matrix.to/#/#solus-packagi
 ## Repository management commands
 
 The following table lists the `eopkg` commands you can use to manage your software sources.
+
 | Action                                 | Command                        | Example                                                                   |
 | -------------------------------------- | ------------------------------ | ------------------------------------------------------------------------- |
 | Add a repository                       | `sudo eopkg add-repo NAME URL` | `sudo eopkg add-repo Example https://example.com/repo/eopkg-index.xml.xz` |

diff --git a/docs/user/quick-start/installation/disks.md b/docs/user/quick-start/installation/disks.md
@@ -19,9 +19,9 @@ Alongside these options, we also provide the ability to use full-disk encryption
 
 ## UEFI
 
-If you are using a system with UEFI, you may need to create a EFI System Partition, also referred to as an ESP. This is not necessary if you are enabling Solus to install onto the entire disk.
+If you are using a system with UEFI, you may need to create an EFI System Partition, also referred to as an ESP. This is not necessary if you are enabling Solus to install onto the entire disk.
 
-To create an EFI System Partition, open up GParted and create a FAT32 partition that is 1GB in size. Next, right-click on the partition and click Manage Flags. On the Manage Flags section, enable the `boot` and `esp` flags.
+To create an EFI System Partition, open up GParted and create a FAT32 partition that is 1&nbsp;GB in size. Next, right-click on the partition and click Manage Flags. On the Manage Flags section, enable the `boot` and `esp` flags.
 
 **Notes:**
 

diff --git a/docs/user/quick-start/installation/secure-boot.md b/docs/user/quick-start/installation/secure-boot.md
@@ -5,13 +5,13 @@ summary: Instructions for enrolling the Solus Certificate when Secure Boot is en
 
 # Booting with Secure Boot Enabled
 
-Since Solus 4.4 secure boot is now supported. When you first boot the ISO, and, if you have secure boot enabled in your UEFI firmware; you will have to perform the one-time-step of manually enrolling the Solus certificate. The following guide will walk you through this. If you already have Solus installed and wish to enable secure boot, skip ahead [here](#enabling-secure-boot-on-an-existing-install).
+Since Solus 4.4 Secure Boot is now supported. When you first boot the ISO, and, if you have Secure Boot enabled in your UEFI firmware; you will have to perform the one-time-step of manually enrolling the Solus certificate. The following guide will walk you through this. If you already have Solus installed and wish to enable Secure Boot, skip ahead [here](#enabling-secure-boot-on-an-existing-install).
 
-<em>Note that this only applies to machines with UEFI firmware, if your machine uses the older BIOS firmware you can safely ignore this article. If you wish to avoid having to do this step then you may disable secure boot in your machine's UEFI firmware interface.</em>
+<em>Note that this only applies to machines with UEFI firmware, if your machine uses the older BIOS firmware you can safely ignore this article. If you wish to avoid having to do this step then you may disable Secure Boot in your machine's UEFI firmware interface.</em>
 
 ## Enrolling the Solus certificate
 
-After [booting](/docs/user/quick-start/installation/#boot-the-media) the ISO from USB/DVD and, if Secure Boot is enabled in your device's UEFI firmware. A warning will appear concerning a secure boot violation, press `Enter` on your keyboard to continue.
+After [booting](/docs/user/quick-start/installation/#boot-the-media) the ISO from USB/DVD and, if Secure Boot is enabled in your device's UEFI firmware. A warning will appear concerning a Secure Boot violation, press `Enter` on your keyboard to continue.
 
 ![Secure Boot violation](1-secure-boot-violation.png)
 
@@ -37,7 +37,7 @@ Now, with the Solus certificate enrolled, press `Enter` to reboot the machine, b
 
 ## Enabling Secure Boot on an existing install
 
-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.
+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` (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.
 
@@ -50,7 +50,7 @@ Reboot your machine and select the appropriate keyboard button during startup to
 
 ![UEFI Choose Boot Device](uefi-choosing-boot-device.png)
 
-After successfully booting from the new `Solus Linux Bootloader` UEFI entry, open a terminal, input `systemctl reboot --firmware-setup` and press `Enter`. This will reboot you into your machine's UEFI firmware interface. Once there, you will have to find and enable the secure boot setting. Where this is located varies from machine to machine. Some common places it can be located under are `Windows OS Configuration`, `Security` or `Device Manager`.
+After successfully booting from the new `Solus Linux Bootloader` UEFI entry, open a terminal, input `systemctl reboot --firmware-setup` and press `Enter`. This will reboot you into your machine's UEFI firmware interface. Once there, you will have to find and enable the Secure Boot setting. Where this is located varies from machine to machine. Some common places it can be located under are `Windows OS Configuration`, `Security` or `Device Manager`.
 
 ![UEFI Secure Boot Configuration](uefi-secure-boot-configuration.png)
 
@@ -64,7 +64,7 @@ Once you've successfully enabled and booted your Solus install with Secure Boot
 
 You can run `bootctl status | grep "Secure Boot"` in a terminal to verify Secure Boot is enabled.
 
-It is possible to delete the old Solus UEFI boot entry with `efibootmgr` once secure boot is enabled successfully, However, caution is required and as such, instructions to do so are not provided here.
+It is possible to delete the old Solus UEFI boot entry with `efibootmgr` once Secure Boot is enabled successfully, However, caution is required and as such, instructions to do so are not provided here.
 
 # Why is enrolling the Solus certificate necessary?
 
@@ -81,7 +81,7 @@ We appreciate that having the enroll the certificate may be confusing to users a
 However, it is also important to consider the following:
 
 - Obtaining an EV certificate is an expensive investment.
-- Enrolling the Solus certificate is only required once, and, only if secure boot is enabled.
+- Enrolling the Solus certificate is only required once, and, only if Secure Boot is enabled.
 
 As such, we are not currently looking to our get our own `shim` signed by Microsoft. However, thanks to our supporters on [OpenCollective](https://opencollective.com/getsolus), it is indeed within our budget to obtain an EV certificate in the future which would unblock the additional requirements.
 

diff --git a/docs/user/quick-start/installation/system-requirements.md b/docs/user/quick-start/installation/system-requirements.md
@@ -5,20 +5,20 @@ summary: Hardware Requirements Guide
 
 # System requirements
 
-- A blank DVD or a USB drive that is at least 3GB
-- On UEFI systems, an EFI partition of 1GB minimum
+- A blank DVD or a USB drive that is at least 3&nbsp;GB
+- On UEFI systems, an EFI partition of 1&nbsp;GB minimum
 - An internet connection
 - System connected to AC power
 
 In order to install Solus, your system must meet the minimum system requirements. Ideally it should meet or exceed the recommended values for a better experience.
 
-|                           | Minimum                          | Recommended                                                                               |
-| ------------------------- | -------------------------------- | ----------------------------------------------------------------------------------------- |
-| **Disk space free**       | 10GB / 9.3GiB                    | 25GB / 23.3GiB                                                                            |
-| **Memory (RAM)**          | 4GB                              | 8GB or more                                                                               |
-| **Processor (CPU)**       | 64-bit (x86_64) processor        | [x86-64-v2](https://en.wikipedia.org/wiki/X86-64#Microarchitecture_levels) 2GHz quad core |
-| **System firmware**       | BIOS / UEFI                      | UEFI                                                                                      |
-| **Display Adapter (GPU)** | Any onboard or dedicated adapter |                                                                                           |
+|                           | Minimum                          | Recommended                                                                                     |
+| ------------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------- |
+| **Disk space free**       | 10&nbsp;GB / 9.3&nbsp;GiB        | 25&nbsp;GB / 23.3&nbsp;GiB                                                                      |
+| **Memory (RAM)**          | 4&nbsp;GB                        | 8&nbsp;GB or more                                                                               |
+| **Processor (CPU)**       | 64-bit (x86-64) processor        | [x86-64-v2](https://en.wikipedia.org/wiki/X86-64#Microarchitecture_levels) 2&nbsp;GHz quad core |
+| **System firmware**       | BIOS / UEFI                      | UEFI                                                                                            |
+| **Display Adapter (GPU)** | Any onboard or dedicated adapter |                                                                                                 |
 
 These are general recommendations. Your requirements may vary based on your intended use of the system.