Some small fixes across repo (#479)

- Missing space in Plasma Troubleshooting admonition - Link to stateless doc not valid (yet) - Updated Thunderbird website link - Caja no longer among standard applications without MATE - Change links from http:// to https:// - Fix some doc links - Grammar/style fixes Signed-off-by: Thomas Staudinger <[email protected]>
getsolus · Feb 2, 2024 · fd74b4e · fd74b4e
1 parent d7f9276
commit fd74b4e
Show file tree

Hide file tree

Showing 14 changed files with 24 additions and 28 deletions.
diff --git a/docs/packaging/advanced-config/local-repository.md b/docs/packaging/advanced-config/local-repository.md
@@ -62,7 +62,7 @@ To generate or refresh the `eopkg` index in `/var/lib/solbuild/local`, use the f
 sudo eopkg index --skip-signing /var/lib/solbuild/local/ --output /var/lib/solbuild/local/eopkg-index.xml
 ```
 
-Or, if you have our [helper functions](docs/packaging/prepare-for-packaging#set-up-monorepo-helper-functions-optional) set up, you get the same result by running:
+Or, if you have our [helper functions](/docs/packaging/prepare-for-packaging#set-up-monorepo-helper-functions-optional) set up, you get the same result by running:
 
 ```bash
 localrepo_reindex

diff --git a/docs/packaging/package.yml.md b/docs/packaging/package.yml.md
@@ -221,7 +221,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#L394-L406) |
+| **%CONFOPTS%**    | Flags / options for configuration, such as `--prefix=%PREFIX%`. [Full List.](https://github.com/getsolus/ypkg/blob/master/ypkg2/rc.yml#L403-L415) |
 | **%CXX%**         | C++ compiler.                                                                                                                                     |
 | **%CXXFLAGS%**    | cxxflags as set in `eopkg.conf`.                                                                                                                  |
 | **%JOBS%**        | jobs, as set in `eopkg.conf`.                                                                                                                     |

diff --git a/docs/packaging/procedures/maintainership.md b/docs/packaging/procedures/maintainership.md
@@ -15,7 +15,7 @@ Each new package which is going to land in the Solus repository must have one or
 - Ensure the [packaging file](/docs/packaging/package.yml) adheres to the Solus [standards](/docs/packaging/packaging-practices)
 - Ensure the application or library is consistent with the Operating System aesthetics, file system conventions and the Solus philosophy in general
 
-On the Solus side however, the community must not forget that maintainers are volunteers, which may or may not have a technical background. More experienced users are to engage new maintainers in a welcoming manner, e.g. by listing their errors and inviting them to fix them. (More on this in the [community guidelines](/docs/user/contributing/community-guidelines#development--issue-trackers))
+On the Solus side however, the community must not forget that maintainers are volunteers, which may or may not have a technical background. More experienced users are to engage new maintainers in a welcoming manner, e.g. by listing their errors and inviting them to fix them. (More on this in the [community guidelines](/docs/user/contributing/community-guidelines#repositories-and-issue-trackers))
 
 The Solus Staff have the right to enforce certain practices, even when in contrast with maintainers' vision. It also has the right to ultimately accept or reject a patch.
 
@@ -37,7 +37,7 @@ If a package is actively maintained, modifications should not occur and the indi
 
 ## Template for the `MAINTAINERS.md` File
 
-Presented here is the `MAINTAINERS.md` file. This file must be provided verbatim alongside the other patch contents, and filled in with the maintainers' personal information. A [Matrix](https://help.getsol.us/docs/user/contributing/getting-involved#matrix-chat) contact is optional but recommended, while an email address is mandatory. Similar to the `.solus/packager` file used for packaging, the maintainers listed in `MAINTAINERS.md` must use their real first and last name(s) for accountability purposes.
+Presented here is the `MAINTAINERS.md` file. This file must be provided verbatim alongside the other patch contents, and filled in with the maintainers' personal information. A [Matrix](/docs/user/contributing/getting-involved#matrix-chat) contact is optional but recommended, while an email address is mandatory. Similar to the `.solus/packager` file used for packaging, the maintainers listed in `MAINTAINERS.md` must use their real first and last name(s) for accountability purposes.
 
 The contact information section is a YAML list. If needed, more elements may be added, each per maintainer. Do not edit the file in any other way, including spacing, except _Name_, _Surname_ and _REPLACEME_ placeholders.
 

diff --git a/docs/user/contributing/style.md b/docs/user/contributing/style.md
@@ -20,13 +20,13 @@ Use the [Google developer documentation style guide](https://developers.google.c
 Some useful pages:
 
 - [Text formatting summary](https://developers.google.com/style/text-formatting)
-- [Procedure](https://developers.google.com/style/procedures)
+- [Procedures](https://developers.google.com/style/procedures)
 - [Timeless documentation](https://developers.google.com/style/timeless-documentation)
 - [Word list](https://developers.google.com/style/word-list)
 
 ## Linux-specific terms
 
-If you are unsure of how to use a common linux term, refer to the [Glossary of terms and conventions](https://redhat-documentation.github.io/supplementary-style-guide/#glossary-terms-conventions) from the _Red Hat supplementary style guide for documentation_
+If you are unsure of how to use a common Linux term, refer to the [Glossary of terms and conventions](https://redhat-documentation.github.io/supplementary-style-guide/#glossary-terms-conventions) from the _Red Hat supplementary style guide for documentation_
 
 ## Specific guidance
 
@@ -81,7 +81,7 @@ console.log("Hello, world!");
   - Example: "The packages repository", instead of "The monorepo".
 - Dev Tracker
   - Avoid using the term _Dev Tracker_.
-  - Example: "The packages issue tracker", instead or "The dev tracker"
+  - Example: "The packages issue tracker", instead of "The dev tracker"
 
 ### Markdown formatting
 

diff --git a/docs/user/intro.md b/docs/user/intro.md
@@ -38,4 +38,4 @@ If you need help with something not covered in the help center, there are variou
 
 Volunteers around the world build and maintain Solus. Due to time zone differences there might not always be people to answer your questions immediately.
 
-:::
+:::
diff --git a/docs/user/quick-start/default-applications.md b/docs/user/quick-start/default-applications.md
@@ -15,7 +15,7 @@ Solus comes pre-installed with Firefox, a secure and trustworthy web browser pro
 
 # Email Client
 
-Solus comes pre-installed with the powerful [Thunderbird](https://www.mozilla.org/thunderbird/) email, newsgroup, and feeds client.
+Solus comes pre-installed with the powerful [Thunderbird](https://www.thunderbird.net/) email, newsgroup, and feeds client.
 
 ![Thunderbird Screenshot](default-applications/thunderbird.jpg)
 
@@ -34,10 +34,6 @@ Each Linux desktop environment has its own graphical application for managing fi
 
 ![Nemo Screenshot](default-applications/nemo.jpg)
 
-## Caja
-
-![Caja Screenshot](default-applications/caja.jpg)
-
 ## GNOME Files
 
 ![GNOME Files Screenshot](default-applications/nautilus.jpg)

diff --git a/docs/user/quick-start/default-applications/caja.jpg b/docs/user/quick-start/default-applications/caja.jpg
diff --git a/docs/user/quick-start/software-center/index.md b/docs/user/quick-start/software-center/index.md
@@ -5,7 +5,7 @@ summary: Introduction to the Solus Software Center
 
 # Software Center
 
-You can install software ranging from Google Chrome to LibreOffice, as well as updating software, via our Software Center.
+You can install software ranging from Google Chrome to LibreOffice, as well as update software, via our Software Center.
 
 ![Software Center](solus-sc.jpg)
 

diff --git a/docs/user/software/command-line/index.md b/docs/user/software/command-line/index.md
@@ -11,9 +11,9 @@ When using a terminal session to perform command-line activities, a Unix shell i
 
 Solus makes available other shells via our repository, with a full list available in `/usr/share/defaults/etc/shells`. Common shells, aside from Bash, are:
 
-- [Dash](http://gondor.apana.org.au/~herbert/dash/)
+- [Dash](https://gondor.apana.org.au/~herbert/dash/)
 - [Fish](https://fishshell.com/)
-- [Zsh](http://zsh.sourceforge.io/)
+- [Zsh](https://zsh.sourceforge.io/)
 
 ### Installation
 
@@ -57,7 +57,7 @@ The fzf project consists of the following components: an `fzf` executable, an `f
 sudo eopkg it fzf
 ```
 
-The shell extensions are not enabled by default after the `fzf` package is installed. The procedures to enable these features are described below. For more tips and examples on the usage of `fzf`, visit its [github](https://github.com/junegunn/fzf) and [wiki](https://github.com/junegunn/fzf/wiki/examples) pages.
+The shell extensions are not enabled by default after the `fzf` package is installed. The procedures to enable these features are described below. For more tips and examples on the usage of `fzf`, visit its [GitHub repository](https://github.com/junegunn/fzf) and [Wiki pages](https://github.com/junegunn/fzf/wiki/examples).
 
 ### Fuzzy Auto-Completion
 

diff --git a/docs/user/software/configuration_files.md b/docs/user/software/configuration_files.md
@@ -9,7 +9,7 @@ These are the standard locations on a Solus installation for software configurat
 
 :::note
 
-Solus uses a "stateless" system configuration. For what that means see [Stateless Configuration](statelessness.md).
+Solus uses a "stateless" system configuration. For what that means see the [Clear Linux Guide to Stateless Configuration](https://www.clearlinux.org/clear-linux-documentation/reference/manpages/stateless.7.html).
 
 :::
 
@@ -33,5 +33,5 @@ Some common configuration files:
 | pam                                                | `/etc/pam.d/`<br />`/usr/share/defaults/etc/pam.d/`     |
 | ssh                                                | `$HOME/.ssh/`<br />`/usr/share/defaults/etc/ssh/`       |
 | ssl                                                | `/etc/ssl/`<br />`/usr/share/defaults/etc/ssl/`         |
-| [tigervnc](docs/user/software/networking/tigervnc) | `$HOME/.vnc/xstartup`                                   |
-| [xrdp](docs/user/software/networking/xrdp)         | `/etc/X11/Xwrapper.config`                              |
+| [tigervnc](/docs/user/software/networking/tigervnc) | `$HOME/.vnc/xstartup`                                   |
+| [xrdp](/docs/user/software/networking/xrdp)         | `/etc/X11/Xwrapper.config`                              |
diff --git a/docs/user/software/development/android.md b/docs/user/software/development/android.md
@@ -73,7 +73,7 @@ First we need to create a directory where we want to download Android.
 mkdir ~/android && cd ~/android
 ```
 
-Next we'll need to initialize the repository with what version of Android you want to build. You can find a list of versions you can checkout [here](https://source.android.com/source/build-numbers#source-code-tags-and-builds).
+Next we'll need to initialize the repository with what version of Android you want to build. You can find a list of versions you can checkout [here](https://source.android.com/docs/setup/reference/build-numbers#source-code-tags-and-builds).
 
 ```bash
 repo init -u https://android.googlesource.com/platform/manifest -b android-8.0.0_r34

diff --git a/docs/user/software/gaming/index.md b/docs/user/software/gaming/index.md
@@ -62,15 +62,15 @@ Integrate the installed files into your system:
 sudo usysconf run -f
 ```
 
-## Retroarch
+## RetroArch
 
-Retroarch is a frontend for emulators, game engines and media players. It has all you need to run classic games through its polished graphical interface.
+RetroArch is a frontend for emulators, game engines and media players. It has all you need to run classic games through its polished graphical interface.
 
-![Retroarch Screenshot](retroarch.jpg)
+![RetroArch Screenshot](retroarch.jpg)
 
 ### Installing the assets
 
-The assets are not packaged with Retroarch itself and have to be downloaded from inside the program. This can easily be done by going into the Online Updater from the Main Menu and selecting "Update Assets".
+The assets are not packaged with RetroArch itself and have to be downloaded from inside the program. This can easily be done by going into the Online Updater from the Main Menu and selecting "Update Assets".
 
 ## Steam
 

diff --git a/docs/user/software/networking/wireshark.md b/docs/user/software/networking/wireshark.md
@@ -26,4 +26,4 @@ sudo setcap cap_dac_override,cap_net_admin,cap_net_raw+eip /usr/bin/dumpcap
 
 ## Usage
 
-Wireshark [User’s Guide](https://www.wireshark.org/docs/wsug_html_chunked/) and [learning material](https://www.wireshark.org/docs/) are available on [https://wireshark.org](https://wireshark.org).
+Wireshark [User’s Guide](https://www.wireshark.org/docs/wsug_html_chunked/) and [learning material](https://www.wireshark.org/docs/) are available on https://www.wireshark.org.
diff --git a/docs/user/troubleshooting/plasma.md b/docs/user/troubleshooting/plasma.md
@@ -35,7 +35,7 @@ You may not need to reboot to recover from this state. Killing all firefox proce
 
 You may be able to fix this by clearing KDE / Plasma cache files.
 
-:::cautionImportant
+:::caution Important
 
 You should not be logged into your Plasma session while deleting the cache files, booting from a live USB is necessary.
 
@@ -93,4 +93,4 @@ You should not be logged into your Plasma session while deleting the cache files
   ```
   cp -rav .kde.bak/share/config/ .kde/share/config
   ```
-  After restoring the files or directories, restart your system.
+  After restoring the files or directories, restart your system.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -38,4 +38,4 @@ If you need help with something not covered in the help center, there are variou

		Volunteers around the world build and maintain Solus. Due to time zone differences there might not always be people to answer your questions immediately.

		:::
		:::
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,4 +26,4 @@ sudo setcap cap_dac_override,cap_net_admin,cap_net_raw+eip /usr/bin/dumpcap

		## Usage

		Wireshark [User’s Guide](https://www.wireshark.org/docs/wsug_html_chunked/) and [learning material](https://www.wireshark.org/docs/) are available on [https://wireshark.org](https://wireshark.org).
		Wireshark [User’s Guide](https://www.wireshark.org/docs/wsug_html_chunked/) and [learning material](https://www.wireshark.org/docs/) are available on https://www.wireshark.org.