Skip to content

Commit fd74b4e

Browse files
Staudeydavidjharder
authored andcommitted
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]>
1 parent d7f9276 commit fd74b4e

File tree

14 files changed

+24
-28
lines changed

14 files changed

+24
-28
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ To generate or refresh the `eopkg` index in `/var/lib/solbuild/local`, use the f
6262
sudo eopkg index --skip-signing /var/lib/solbuild/local/ --output /var/lib/solbuild/local/eopkg-index.xml
6363
```
6464

65-
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:
65+
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:
6666

6767
```bash
6868
localrepo_reindex

docs/packaging/package.yml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ BOLT is a post-link optimizer developed to speed up large applications. You will
221221
| **%ARCH%** | Indicates the current build architecture. |
222222
| **%CC%** | C compiler. |
223223
| **%CFLAGS%** | cflags as set in `eopkg.conf`. |
224-
| **%CONFOPTS%** | Flags / options for configuration, such as `--prefix=%PREFIX%`. [Full List.](https://github.com/getsolus/ypkg/blob/master/ypkg2/rc.yml#L394-L406) |
224+
| **%CONFOPTS%** | Flags / options for configuration, such as `--prefix=%PREFIX%`. [Full List.](https://github.com/getsolus/ypkg/blob/master/ypkg2/rc.yml#L403-L415) |
225225
| **%CXX%** | C++ compiler. |
226226
| **%CXXFLAGS%** | cxxflags as set in `eopkg.conf`. |
227227
| **%JOBS%** | jobs, as set in `eopkg.conf`. |

docs/packaging/procedures/maintainership.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Each new package which is going to land in the Solus repository must have one or
1515
- Ensure the [packaging file](/docs/packaging/package.yml) adheres to the Solus [standards](/docs/packaging/packaging-practices)
1616
- Ensure the application or library is consistent with the Operating System aesthetics, file system conventions and the Solus philosophy in general
1717

18-
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))
18+
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))
1919

2020
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.
2121

@@ -37,7 +37,7 @@ If a package is actively maintained, modifications should not occur and the indi
3737

3838
## Template for the `MAINTAINERS.md` File
3939

40-
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.
40+
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.
4141

4242
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.
4343

docs/user/contributing/style.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ Use the [Google developer documentation style guide](https://developers.google.c
2020
Some useful pages:
2121

2222
- [Text formatting summary](https://developers.google.com/style/text-formatting)
23-
- [Procedure](https://developers.google.com/style/procedures)
23+
- [Procedures](https://developers.google.com/style/procedures)
2424
- [Timeless documentation](https://developers.google.com/style/timeless-documentation)
2525
- [Word list](https://developers.google.com/style/word-list)
2626

2727
## Linux-specific terms
2828

29-
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_
29+
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_
3030

3131
## Specific guidance
3232

@@ -81,7 +81,7 @@ console.log("Hello, world!");
8181
- Example: "The packages repository", instead of "The monorepo".
8282
- Dev Tracker
8383
- Avoid using the term _Dev Tracker_.
84-
- Example: "The packages issue tracker", instead or "The dev tracker"
84+
- Example: "The packages issue tracker", instead of "The dev tracker"
8585

8686
### Markdown formatting
8787

docs/user/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ If you need help with something not covered in the help center, there are variou
3838

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

41-
:::
41+
:::

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Solus comes pre-installed with Firefox, a secure and trustworthy web browser pro
1515

1616
# Email Client
1717

18-
Solus comes pre-installed with the powerful [Thunderbird](https://www.mozilla.org/thunderbird/) email, newsgroup, and feeds client.
18+
Solus comes pre-installed with the powerful [Thunderbird](https://www.thunderbird.net/) email, newsgroup, and feeds client.
1919

2020
![Thunderbird Screenshot](default-applications/thunderbird.jpg)
2121

@@ -34,10 +34,6 @@ Each Linux desktop environment has its own graphical application for managing fi
3434

3535
![Nemo Screenshot](default-applications/nemo.jpg)
3636

37-
## Caja
38-
39-
![Caja Screenshot](default-applications/caja.jpg)
40-
4137
## GNOME Files
4238

4339
![GNOME Files Screenshot](default-applications/nautilus.jpg)
Binary file not shown.

docs/user/quick-start/software-center/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ summary: Introduction to the Solus Software Center
55

66
# Software Center
77

8-
You can install software ranging from Google Chrome to LibreOffice, as well as updating software, via our Software Center.
8+
You can install software ranging from Google Chrome to LibreOffice, as well as update software, via our Software Center.
99

1010
![Software Center](solus-sc.jpg)
1111

docs/user/software/command-line/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ When using a terminal session to perform command-line activities, a Unix shell i
1111

1212
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:
1313

14-
- [Dash](http://gondor.apana.org.au/~herbert/dash/)
14+
- [Dash](https://gondor.apana.org.au/~herbert/dash/)
1515
- [Fish](https://fishshell.com/)
16-
- [Zsh](http://zsh.sourceforge.io/)
16+
- [Zsh](https://zsh.sourceforge.io/)
1717

1818
### Installation
1919

@@ -57,7 +57,7 @@ The fzf project consists of the following components: an `fzf` executable, an `f
5757
sudo eopkg it fzf
5858
```
5959

60-
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.
60+
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).
6161

6262
### Fuzzy Auto-Completion
6363

docs/user/software/configuration_files.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ These are the standard locations on a Solus installation for software configurat
99

1010
:::note
1111

12-
Solus uses a "stateless" system configuration. For what that means see [Stateless Configuration](statelessness.md).
12+
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).
1313

1414
:::
1515

@@ -33,5 +33,5 @@ Some common configuration files:
3333
| pam | `/etc/pam.d/`<br />`/usr/share/defaults/etc/pam.d/` |
3434
| ssh | `$HOME/.ssh/`<br />`/usr/share/defaults/etc/ssh/` |
3535
| ssl | `/etc/ssl/`<br />`/usr/share/defaults/etc/ssl/` |
36-
| [tigervnc](docs/user/software/networking/tigervnc) | `$HOME/.vnc/xstartup` |
37-
| [xrdp](docs/user/software/networking/xrdp) | `/etc/X11/Xwrapper.config` |
36+
| [tigervnc](/docs/user/software/networking/tigervnc) | `$HOME/.vnc/xstartup` |
37+
| [xrdp](/docs/user/software/networking/xrdp) | `/etc/X11/Xwrapper.config` |

docs/user/software/development/android.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ First we need to create a directory where we want to download Android.
7373
mkdir ~/android && cd ~/android
7474
```
7575

76-
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).
76+
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).
7777

7878
```bash
7979
repo init -u https://android.googlesource.com/platform/manifest -b android-8.0.0_r34

docs/user/software/gaming/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,15 @@ Integrate the installed files into your system:
6262
sudo usysconf run -f
6363
```
6464

65-
## Retroarch
65+
## RetroArch
6666

67-
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.
67+
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.
6868

69-
![Retroarch Screenshot](retroarch.jpg)
69+
![RetroArch Screenshot](retroarch.jpg)
7070

7171
### Installing the assets
7272

73-
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".
73+
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".
7474

7575
## Steam
7676

docs/user/software/networking/wireshark.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ sudo setcap cap_dac_override,cap_net_admin,cap_net_raw+eip /usr/bin/dumpcap
2626

2727
## Usage
2828

29-
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).
29+
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.

docs/user/troubleshooting/plasma.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ You may not need to reboot to recover from this state. Killing all firefox proce
3535

3636
You may be able to fix this by clearing KDE / Plasma cache files.
3737

38-
:::cautionImportant
38+
:::caution Important
3939

4040
You should not be logged into your Plasma session while deleting the cache files, booting from a live USB is necessary.
4141

@@ -93,4 +93,4 @@ You should not be logged into your Plasma session while deleting the cache files
9393
```
9494
cp -rav .kde.bak/share/config/ .kde/share/config
9595
```
96-
After restoring the files or directories, restart your system.
96+
After restoring the files or directories, restart your system.

0 commit comments

Comments
 (0)