From c6e31269b2dc50784fdd979512241e45017653cc Mon Sep 17 00:00:00 2001 From: Thomas Staudinger Date: Mon, 29 Apr 2024 15:59:40 +0200 Subject: [PATCH] Additional small fixes across the repo (#530) Change all remaining headers to sentence case as demanded by style guide Signed-off-by: Thomas Staudinger --- docs/packaging/creating-a-new-package.md | 10 ++--- docs/packaging/index.md | 6 +-- docs/packaging/prepare-for-packaging.md | 20 ++++----- docs/packaging/procedures/maintainership.md | 6 +-- .../packaging/procedures/package-inclusion.md | 10 ++--- docs/packaging/submitting-a-pull-request.mdx | 14 +++---- docs/packaging/testing-a-package.md | 6 +-- docs/packaging/update-dev-environment.md | 6 +-- .../packaging/updating-an-existing-package.md | 14 +++---- docs/packaging/your-first-package-update.md | 4 +- .../user/contributing/community-guidelines.md | 4 +- docs/user/contributing/getting-involved.md | 14 +++---- docs/user/contributing/style.md | 4 +- docs/user/editions/gnome/configuration.md | 28 ++++++------- docs/user/editions/mate/configuration.md | 30 ++++++------- docs/user/editions/plasma/configuration.md | 32 +++++++------- docs/user/editions/plasma/tips-and-tricks.md | 6 +-- docs/user/hardware/compatibility/laptops.md | 6 +-- docs/user/hardware/index.md | 42 +++++++++---------- docs/user/hardware/mobile/android.md | 6 +-- docs/user/hardware/mobile/apple.md | 4 +- .../peripherals/mice-and-touchpads.md | 4 +- .../hardware/peripherals/midi-keyboard.md | 6 +-- .../peripherals/printers-and-scanners.md | 4 +- docs/user/package-management/basics.md | 14 +++---- .../history-and-rollback.md | 4 +- .../package-management/repo-management.md | 14 +++---- docs/user/privacy.md | 20 ++++----- docs/user/quick-start/boot-management.md | 18 ++++---- docs/user/quick-start/installation/index.md | 10 ++--- .../quick-start/installation/secure-boot.md | 10 ++--- docs/user/software/camera/droidcam.md | 2 +- docs/user/software/development/containers.md | 2 +- docs/user/software/development/index.md | 6 +-- docs/user/software/development/java.md | 5 ++- .../software/development/r-and-rstudio.md | 22 +++++----- docs/user/software/development/rust.md | 2 +- docs/user/software/development/web.md | 2 +- docs/user/software/localization/ibus.md | 24 +++++------ docs/user/software/sound/index.md | 2 +- docs/user/software/third-party/index.md | 12 +++--- .../software/virtualization/virtualbox.md | 12 +++--- docs/user/software/web/obs.md | 4 +- docs/user/troubleshooting/boot-rescue.md | 12 +++--- docs/user/troubleshooting/index.md | 4 +- 45 files changed, 243 insertions(+), 244 deletions(-) diff --git a/docs/packaging/creating-a-new-package.md b/docs/packaging/creating-a-new-package.md index c9ec89bc3..509902867 100644 --- a/docs/packaging/creating-a-new-package.md +++ b/docs/packaging/creating-a-new-package.md @@ -30,7 +30,7 @@ git switch main git pull ``` -## Create a New Branch +## Create a new branch It's always a good idea to switch to a new git branch before beginning packaging work. This helps to separate your work from any new changes made to the package repository, which will allow you to more easily rebase any changes if needed. To do so run: @@ -38,11 +38,11 @@ It's always a good idea to switch to a new git branch before beginning packaging git switch -c your-branch ``` -## Create The `MAINTAINERS.md` File +## Create the `MAINTAINERS.md` file You must add a file called `MAINTAINERS.md` using the template in [Maintainership](procedures/maintainership.md). Solus uses this to track the primary maintainer(s) for each package. -## Create the `package.yml` File +## Create the `package.yml` file You will need a link to the most recent source tarball for this from the software's website. @@ -124,7 +124,7 @@ To read more about finding and including dependencies and other parts of `packag Understanding how to translate source code into a good `package.yml` file is the heart of packaging. If you are stumped, or have questions, **ask for help in our Solus Packaging room on [Matrix](/docs/user/contributing/getting-involved#matrix-chat).** -## Build the Package +## Build the package Build the package using `go-task`. The default task will build the package against the Unstable repository, so you don't have to specify a task here. @@ -146,7 +146,7 @@ All these files _except_ the `*eopkg` file(s) should be included in your pull re Once your package has built successfully, you will need to [test it](testing-a-package). -## Commit your Changes +## Commit your changes Check the [changes in your files](git-basics#check-the-changes-in-your-files). diff --git a/docs/packaging/index.md b/docs/packaging/index.md index 26758a671..bfbc9e2ea 100644 --- a/docs/packaging/index.md +++ b/docs/packaging/index.md @@ -8,20 +8,20 @@ sidebar_position: 0 This is the overall workflow for creating or updating a package. -## Development Environment Preparation +## Development environment preparation 1. [Prepare for Packaging](prepare-for-packaging.md) 2. Review the [requirements for the package.yml file](docs/packaging/package.yml.md). 3. Also review our [Packaging Practices](docs/packaging/packaging-practices.md). -## Prior to Building a Package +## Prior to building a package Please check the following: - Search [open package requests](https://github.com/getsolus/packages/issues?q=label%3A%22Package+Request%22) to see if there is one for the package. If there isn't an existing issue, go ahead and submit your pull request. If there is already a pull request, please check its status to avoid duplicating work. - If you are submitting a pull request for the inclusion of software in the repo, the package has a corresponding package request that is **accepted for inclusion** or is a dependency of a package that has been accepted into the repository. -## Building Packages +## Building packages 1. [Update your development environment](update-dev-environment.md) 2. Prepare the package directory and build the package diff --git a/docs/packaging/prepare-for-packaging.md b/docs/packaging/prepare-for-packaging.md index ecce6ae01..89d2762b5 100644 --- a/docs/packaging/prepare-for-packaging.md +++ b/docs/packaging/prepare-for-packaging.md @@ -88,11 +88,11 @@ To update solbuild, run: sudo solbuild update ``` -## Fork the getsolus/packages Repository +## Fork the getsolus/packages repository Create your own fork of [getsolus/packages](https://github.com/getsolus/packages) using the GitHub web UI or [`gh` cli tool](https://cli.github.com/manual/gh_repo_fork) from the `github-cli` package. It will be forked to `github.com/yourgithubaccount/packages`. -## Clone Your forked package repository +## Clone your forked package repository Create a local clone of the package repository you just forked. Here we are using the name `solus-packages` and cloning it into our home directoy. The rest of the documentation will presume this structure. You can choose a different name and path but will have to make sure to replace it in every command that refers to the `solus-packages` directory. @@ -114,7 +114,7 @@ go-task -d ~/solus-packages init This makes it easy to create commits in the correct format, and will warn you about issues with changes you commit. -## Set up repository helper functions (Optional) +## Set up repository helper functions (optional) The helper functions are a collection of shell scripts that help you navigate the packages repository more quickly, and perform some specialized searches. @@ -147,14 +147,14 @@ ln -s ~/solus-packages/common/Scripts/helpers.zsh ~/.zshrc.d/solus-monorepo-help You should now have the following available from your shell: -| Function | Description | Usage | -| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | -| **cpesearch** | Search for CPE Names for packages. For use when writing the [`monitoring.yml`](/docs/packaging/monitoring.yml.md) file for a package | `cpesearch search-term` | -| **goroot** | When in the Solus packages repository, change directory to the root directory. | `goroot` | -| **gotopkg** | Change directory to any Solus package. You can type part of the package name then double press `Tab` to get autocompletion for this function. | `gotopkg firefox` | -| **gotosoluspkgs** | Change directory to the Solus packages repository from anywhere on the filesystem. | `gotosoluspkgs` | +| Function | Description | Usage | +| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | +| **cpesearch** | Search for CPE Names for packages. For use when writing the [`monitoring.yml`](/docs/packaging/monitoring.yml.md) file for a package | `cpesearch search-term` | +| **goroot** | When in the Solus packages repository, change directory to the root directory. | `goroot` | +| **gotopkg** | Change directory to any Solus package. You can type part of the package name then double press `Tab` to get autocompletion for this function. | `gotopkg firefox` | +| **gotosoluspkgs** | Change directory to the Solus packages repository from anywhere on the filesystem. | `gotosoluspkgs` | | **whatprovides** | Find out what package provides a library by reading the `abi_libs` files. | `whatprovides libfoobar.so.1` | -| **whatuses** | Find out what packages use a library by reading the `abi_used_libs` files. | `whatuses libfoobar.so.1` | +| **whatuses** | Find out what packages use a library by reading the `abi_used_libs` files. | `whatuses libfoobar.so.1` | ## Building packages diff --git a/docs/packaging/procedures/maintainership.md b/docs/packaging/procedures/maintainership.md index e8364b2e7..2b4f22cbf 100644 --- a/docs/packaging/procedures/maintainership.md +++ b/docs/packaging/procedures/maintainership.md @@ -19,11 +19,11 @@ On the Solus side however, the community must not forget that maintainers are vo 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. -## Stepping In +## Stepping in To officially step in as the maintainer of a package, a `MAINTAINERS.md` file must be provided for accepted packages that are not yet included in the repository, or if the package predates the policy of requiring one. Instead, if a previously maintained package is marked by Solus Staff as needing a new maintainer, the `MAINTAINERS.md` file must be updated. -## Updating a Maintained Package +## Updating a maintained package The procedure varies depending on whether or not the individual is the maintainer. @@ -35,7 +35,7 @@ Maintainers are free to [update a package](/docs/packaging/updating-an-existing- If a package is actively maintained, modifications should not occur and the individual should exercise patience when it comes to updates. In some cases, a maintainer may intentionally be holding back a package, or has simply not updated yet. If pertinent, the individual should file a [package update request](/docs/packaging/procedures/request-a-package-update). Alternatively, the individual can reach the maintainers or Solus Staff via the Solus Packaging room on [Matrix](/docs/user/contributing/getting-involved#matrix-chat) and ask permission to update the package. It is also possible to submit an update and attach a message to it clarifying the intention of updating the package, although this is a special case reserved to e.g. security updates. -## Template for the `MAINTAINERS.md` File +## 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](/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. diff --git a/docs/packaging/procedures/package-inclusion.md b/docs/packaging/procedures/package-inclusion.md index 1b4d0053e..b2f1616e4 100644 --- a/docs/packaging/procedures/package-inclusion.md +++ b/docs/packaging/procedures/package-inclusion.md @@ -9,20 +9,20 @@ This policy sets forth the criteria for a package to be accepted for inclusion i ## Criteria -### Explicitly Redistributable +### Explicitly redistributable - Software under a free software or open source software license, or license text which explicitly states that it is **permissible** to redistribute the software. We use the [SPDX License List](https://spdx.org/licenses/). - For anything that cannot be redistributed by Solus, there is the possibility for them to be provided as a Flatpak, for Third Party repository inclusion, however the Solus project is not responsible for flatpak or snap implementation of these items. These items should then fetch only at installation time, and not contain non distributable components. - Solus supports both VCS (currently only git, this will expand) and traditional software sources (such as tarballs) for packages, equally. - Unless **absolutely unavoidable**, the sources for a package should be source, and not **binary, prebuilt** sources. Exceptions may be made in rare cases, such as stage1 bootstrap for a compiler, or requires custom components otherwise impossible to provide in Solus (patched libraries, etc.) -### Server Software +### Server software - Mail servers such as Postfix, Dovecot, etc, are **not** eligible for inclusion. Solus does not provide a server operating system. - Web servers and database daemons **are** eligible for inclusion, as they facilitate web developers to work locally. - Anything outside of these may be catered to by the usage of Docker, or other container technology. Thus, container technology must be supported by Solus to support access to ancillary cases. -### Software Age +### Software age - DOA (dead-on-arrival) packages are generally rejected from Solus. However, they may be included at the discretion of the project, if they provide unique functionality. - Projects with no tags/tarballs which lack traction, may be frozen until a suitable release is made. Tagging releases is an indicator for good release engineering practices. @@ -30,12 +30,12 @@ This policy sets forth the criteria for a package to be accepted for inclusion i - The software has significant traction (i.e. prerelease) - A bug fix only exists beyond the latest stable release for a git source -### Stack Complexity +### Stack complexity - Certain requests may tick all the boxes, but introduce a level of complexity or require a level of engagement not possible to balance for Solus Staff. Under certain situations, a request will be frozen until it has a dedicated maintainer. - This extends to requests for full desktop environments. However, this does not extend to minor components like drop-in window managers or panels separate of a dependent stack (i.e. Awesome WM, tint2, etc.) -### Value Add +### Value-add - A web wrapper which **adds value**, such as Discord, with the global push-to-talk shortcut, is eligible for inclusion. - A web page wrapper, that adds **no further value** other than “convenient desktop shortcut” or “tray icon”, are **not** eligible for inclusion. Web browsers already support desktop notifications. diff --git a/docs/packaging/submitting-a-pull-request.mdx b/docs/packaging/submitting-a-pull-request.mdx index 5ae07a1c0..b35fba443 100644 --- a/docs/packaging/submitting-a-pull-request.mdx +++ b/docs/packaging/submitting-a-pull-request.mdx @@ -17,7 +17,7 @@ Please refrain from submitting a pull request for the following instances: We welcome you to politely reach out via the package request issue or our Support room on [Matrix](/docs/user/contributing/getting-involved#matrix-chat) if you deem the review of the request to be time-sensitive in nature. - If your pull request is a Work In Progress / WIP. Pull requests that are completed or are marked as _request for comments_ (RFC) are accepted. For RFC request please ensure your patch title contains `[RFC]` and is marked as 'draft'. WIP patches clutter the issue tracker, make patch review by Solus Staff more time consuming, and introduce unnecessary work. -## Final Branch Review +## Final branch review At minimum, your pull request will include changes for the following files: @@ -41,9 +41,9 @@ Take a final look over your commit message to make sure it has all the necessary git log -1 ``` -## Creating the Pull Request +## Creating the pull request -There are multiple ways to create a Pull Request with GitHub, either from the website, or from the command line. +There are multiple ways to create a pull request with GitHub, either from the website, or from the command line. @@ -91,7 +91,7 @@ There are multiple ways to create a Pull Request with GitHub, either from the we -## Amending a Pull Request +## Amending a pull request There may be times you need to make minor changes after submitting the pull request. For instance, you see something that needs correcting. To do this, you will need to amend your commit. @@ -108,7 +108,7 @@ We want amended commits because of the way our tooling works. It expects that th ::: -### Amending a Pull Request with multiple commits +### Amending a pull request with multiple commits Sometimes, you may be submitting multiple packages in a single pull request, and one of them might need changes. The process is very similar to the above steps, but with a couple of additions. @@ -122,13 +122,13 @@ Sometimes, you may be submitting multiple packages in a single pull request, and 8. Repeat steps 4 through 7 for all commits you wish to edit 9. Push the amended stack: `git push --force` -## Updating a Pull Request That Has Changes Requested +## Updating a pull request that has changes requested Your pull request will be reviewed, and changes may be requested. This is normal. It's to ensure the quality of the packages in our repository and to make sure each PR adheres to our standards. If you need to make changes in response to a review, follow the steps in the [section above](#amending-a-pull-request). -## After the Pull Request is Accepted +## After the pull request is accepted Once your pull request is accepted and merged, someone on the Solus Team will issue a build. Your new / updated package will be published to the unstable repos. diff --git a/docs/packaging/testing-a-package.md b/docs/packaging/testing-a-package.md index 4a6836d0e..9f4a67a83 100644 --- a/docs/packaging/testing-a-package.md +++ b/docs/packaging/testing-a-package.md @@ -10,7 +10,7 @@ After building a package, it must be tested against the unstable repository befo You will use the `.eopkg` file(s) created by the build process for testing. -## Install the `.eopkg` Files +## Install the `.eopkg` files To install your new package, run the following command in the directory where you built the package. Include **all** `.eopkg` files that were built. @@ -22,7 +22,7 @@ Testing need not be very complicated. The goal is to ensure the package will rel For example, if you were updating a text editor, you would want to make sure you can open, create and save files. If you know of issues the package has had in the past, it's a good idea to test that as well to make sure there are no regressions. There are plenty of historical pull requests to review if you want more detail. -## For Updated Packages: Return to the Repository Version +## For updated packages: Return to the repository version It is a good idea to uninstall the package you built, and return to the repository version, once you are done testing. To do this, run the following command on the main application. For example, if you just built and tested `tree`: @@ -30,7 +30,7 @@ It is a good idea to uninstall the package you built, and return to the reposito sudo eopkg it --reinstall tree ``` -## Remove the `.eopkg` Files +## Remove the `.eopkg` files Before you can submit your pull request, you need to remove the `.eopkg` files. All repository packages are built by a dedicated build server from the source files provided in your pull request. diff --git a/docs/packaging/update-dev-environment.md b/docs/packaging/update-dev-environment.md index d23cdddba..23abbf9c8 100644 --- a/docs/packaging/update-dev-environment.md +++ b/docs/packaging/update-dev-environment.md @@ -13,11 +13,11 @@ Always make sure your development environment and system are up to date before b 3. Update the solbuild base image `sudo solbuild update` 4. Update the system. -## Update Your Fork of the getsolus/packages Repository +## Update your fork of the getsolus/packages repository If you already have a fork of [getsolus/packages](https://github.com/getsolus/packages) in GitHub, log into GitHub. Make sure you're looking at the `main` branch. Check to see that your fork is up to date with the main repository it was forked from. If your fork indicates it is behind, use the "Sync fork" button to bring it up to date. -## Update Your Local Clone of Your Fork +## Update your local clone of your fork If you already have a local clone, you need to bring it up to date. To do so run: @@ -27,7 +27,7 @@ git switch main git pull ``` -## Update `solbuild` and the System +## Update `solbuild` and the system ```bash sudo solbuild update diff --git a/docs/packaging/updating-an-existing-package.md b/docs/packaging/updating-an-existing-package.md index 9f767d8df..0cc13f393 100644 --- a/docs/packaging/updating-an-existing-package.md +++ b/docs/packaging/updating-an-existing-package.md @@ -19,7 +19,7 @@ This PR resolves software update request https://github.com/getsolus/packages/is ::: -### Update your clone of the packages Repository +### Update your clone of the packages repository If you do not have a local clone set up yet, see [Prepare for Packaging](prepare-for-packaging.md#fork-the-getsoluspackages-repository) @@ -31,7 +31,7 @@ git switch main git pull ``` -## Switch to a New Git Branch +## Switch to a new git branch It's always a good idea to switch to a new git branch before beginning packaging work. This helps to separate your work from any new changes made to the package repository, which will allow you to more easily rebase any changes if needed. To do so run: @@ -39,13 +39,13 @@ It's always a good idea to switch to a new git branch before beginning packaging git switch -c update_nano ``` -## Updating a Package +## Updating a package There are two types of package updates: a package bump, and moving a package to a different version. Bumping a package is typically done when rebuilding against a changed dependency, such as `imagemagick` needing to be rebuilt if `libwebp` changes. It is also done if changes are being made to the package, such as adding new dependencies or other modifications which aren't a version update. -### Bumping a Package +### Bumping a package Bumping can be achieved by running the `bump` task, which increments the release number by 1. @@ -63,7 +63,7 @@ git diff package.yml Certain packages with long descriptions might have their description messed up when this is run. Check if this happened, and fix it if necessary. ::: -### Using a Different Version +### Using a different version To update the package to a newer version, use the `update` task. @@ -80,7 +80,7 @@ Example: go-task update -- 1.0 https://example.com/example-1.0.tar.xz ``` -## The `MAINTAINERS.md` File +## The `MAINTAINERS.md` file There must be a file called `MAINTAINERS.md` using the template in [Maintainership](procedures/maintainership.md). Add it if it does not already exist. It should name the current maintainer(s) of the package. @@ -94,7 +94,7 @@ go-task Once your package has built successfully, you will need to [test it](testing-a-package). -## Commit Your Changes +## Commit your changes Check the [changes in your files](git-basics#check-the-changes-in-your-files). diff --git a/docs/packaging/your-first-package-update.md b/docs/packaging/your-first-package-update.md index 31d49c765..71c1f6c7c 100644 --- a/docs/packaging/your-first-package-update.md +++ b/docs/packaging/your-first-package-update.md @@ -71,7 +71,7 @@ abi_used_symbols nano-7.2-162-1-x86_64.eopkg pspec_x86_64.xml Congratulations! You have successfully built your first package on Solus. -## Installing Your New `nano` Package +## Installing your new `nano` package To install your new `nano` package, run the following command. Your filename will probably be slightly different. @@ -85,7 +85,7 @@ Testing `nano` is pretty easy. Testing other packages may be more complicated, d To test your newly built `nano` package, simply run it on command line, then make sure you can edit and save a file. -## Returning to the Repository version (optional) +## Returning to the repository version (optional) It is a good idea to remove the package you built, and return to the repository version, once you are done testing. diff --git a/docs/user/contributing/community-guidelines.md b/docs/user/contributing/community-guidelines.md index 92b5720c7..d9988b81b 100644 --- a/docs/user/contributing/community-guidelines.md +++ b/docs/user/contributing/community-guidelines.md @@ -13,8 +13,8 @@ Our guidelines apply to all services offered or used by the project, in addition The guidelines laid out in this section apply to all services offered or used by the project, such as (but not limited to): -- Our Development Tracker -- Any and all forums or organized communities, e.g. our Forums or sub-reddit +- Our package issue tracker +- Any and all forums or organized communities, e.g. our Flarum forums or subreddit - Matrix, IRC, or any other officially supported means of communicating with the project and community members in real-time - Postings to social media pages / properties owned or used by the project. diff --git a/docs/user/contributing/getting-involved.md b/docs/user/contributing/getting-involved.md index 72d48b0ae..214b38456 100755 --- a/docs/user/contributing/getting-involved.md +++ b/docs/user/contributing/getting-involved.md @@ -7,13 +7,13 @@ summary: Getting involved with the Solus community Solus is a big undertaking, and as such there are many ways in which your involvement can help us. Naturally, that means there are also many ways in which you can help out. -## Engaging with the Community +## Engaging with the community -### Community Guidelines +### 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). -### Community Forums +### 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). @@ -41,9 +41,9 @@ Alongside the forums, you can communicate with developers or others in the commu ## Funding -Solus is funded through our [Open Collective](https://opencollective.com/getsolus), with our fiscal host being the non-profit 501(c)(3) organization [Open Source Collective](https://www.oscollective.org/). To read more about what this funding enables us to do take a look at the ["About" section of our Open Collective page](https://opencollective.com/getsolus#category-ABOUT). +Solus is funded through our [Open Collective](https://opencollective.com/getsolus), with our fiscal host being the non-profit 501(c)(3) organization [Open Source Collective](https://oscollective.org/). To read more about what this funding enables us to do take a look at the ["About" section of our Open Collective page](https://opencollective.com/getsolus#category-ABOUT). -## Improving Documentation +## Improving documentation Our Help Center improves when the documentation improves. If there are docs that you think would be valuable to add, get involved by submitting pull requests to our [Help Center Docs](https://github.com/getsolus/help-center-docs) repository! @@ -52,7 +52,7 @@ Our Help Center improves when the documentation improves. If there are docs that There may be software you wish to have on your system that is currently not available in the repository. While you are more than welcome to submit a bug and wait for someone else to package the software you want, you can also improve and contribute to the community by packaging software. If you're interested in learning to package software, feel free to visit our documentation [here](/docs/packaging/). -## Report Bugs +## 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. @@ -67,4 +67,4 @@ We're always looking to improve our systems, especially when they're not functio ## Translations -Assistance is always welcome in translating our projects [to other languages](https://translate.getsol.us)! +Assistance is always welcome in translating our projects [to other languages](/docs/packaging/translation-instructions)! diff --git a/docs/user/contributing/style.md b/docs/user/contributing/style.md index 4d129822c..b5c9ff78c 100644 --- a/docs/user/contributing/style.md +++ b/docs/user/contributing/style.md @@ -87,9 +87,9 @@ console.log("Hello, world!"); ### Markdown formatting -Write content using [markdown formatting](https://www.markdownguide.org/cheat-sheet/), use [Prettier](https://prettier.io/) to enforce consistent formatting. +Write content using [Markdown formatting](https://www.markdownguide.org/cheat-sheet/), use [Prettier](https://prettier.io/) to enforce consistent formatting. -## Package Names +## Package names - The name of packages in the Solus repository must use inline code formatting. diff --git a/docs/user/editions/gnome/configuration.md b/docs/user/editions/gnome/configuration.md index 7c21b294e..8e1624bd0 100644 --- a/docs/user/editions/gnome/configuration.md +++ b/docs/user/editions/gnome/configuration.md @@ -5,9 +5,9 @@ summary: Help for configuring GNOME Shell on Solus # Configuration -# System +## System -## Date and Time +### Date and time To change the date and time settings in GNOME, you can open the Overlay using the `Super` button on your keyboard or by clicking the applications icon in the dock and then finding and clicking on "Date & Time". @@ -19,7 +19,7 @@ If you wish to change how the time is displayed in the top panel, go back to the ![GNOME Tweak Tool: Top Bar](configuration/gnome-tweak-tool-top-bar.jpg) -## Default Applications +### Default applications With GNOME, you will need to open the Overlay using the `Super` button on your keyboard or by clicking the applications icon in the dock and then finding and clicking on "Details". @@ -61,7 +61,7 @@ Click "Apply" once you are happy with your changes. You will be shown a message ![GNOME Confirm Display Settings](configuration/gnome-display-confirm.jpg) -## Keyboard Layout +## Keyboard layout With GNOME, open the Overlay using the `Super` button on your keyboard or by clicking the applications icon in the dock and then find and click on "Region and Language". @@ -109,7 +109,7 @@ If your language does not appear in the list, click the ⋮ button at the bottom Once you have selected the language you wish to use, click "Done". You _may_ need to logout and login to your computer for it to take affect. -## Mouse and Touchpad +## Mouse and touchpad With GNOME, open the Overlay using the `Super` button on your keyboard or by clicking the applications icon in the dock and then find and click on "Mouse and Touchpad". You will see either settings for your mouse or trackpad, depending on the device. @@ -147,7 +147,7 @@ Easily change network settings with GNOME by left or right clicking on the syste Alternatively, you can open the Overlay using the `Super` button on your keyboard or by clicking the applications icon in the dock and then finding and clicking on "Network". -### Non-Hidden Network +### Non-hidden network Once you have opened the "WiFi Not Connected" menu, click on "Select Network". Click on the network you wish to join and then on "Connect". @@ -159,7 +159,7 @@ You may now be prompted to authenticate with the network. Type in your password If your password is correct, you will now be authenticated with the network. -### Hidden Network +### Hidden network To join a hidden network, open the "WiFi Not Connected" menu and click on "WiFi Settings". @@ -171,7 +171,7 @@ Next, click on “Connect to Hidden Network...”. It will show the following di If the network is found and has a password, you will be prompted to authenticate with the network. -## Sound and Sound Devices +## Sound and sound devices With GNOME, the volume can be changed by left or right clicking the system tray in the top panel and then simply dragging the volume slider with your mouse. @@ -197,7 +197,7 @@ To manage your own or other accounts, you first need to authenticate. Click the In the event the password provided is correct, the "Unlock" button will change to "Add User..." -### Adding a User +### Adding a user To add a user, click the "Add User..." button in the top right corner of the Users window. @@ -209,7 +209,7 @@ This will open the Add User window (shown below). Fill in the required items and then finish adding the new user by clicking "Add" in the top right corner. -### Removing a User +### Removing a user To remove a user, open the Users window and then click on the user you wish to remove. Now click on the red "Remove User..." button in the bottom right corner. @@ -219,9 +219,9 @@ Upon clicking to remove the user, you will be given the option to keep their fil ![GNOME Keep Files Prompt](configuration/gnome-keep-files-prompt.jpg) -# User Interface +## User interface -## Desktop Background +### Desktop background The GNOME desktop background can be changed by simply right clicking anywhere on the desktop and selecting "Change background". @@ -237,7 +237,7 @@ In this section, you can choose between Solus wallpapers, pictures in your Pictu ![GNOME Background Selection](configuration/gnome-background-selection.jpg) -## Desktop Icons +### Desktop icons In GNOME, you can enable desktop items by opening the Overlay using the `Super` button on your keyboard or by clicking the Applications icon in the dock and then search for and open "Tweak Tool". You can then toggle them on and off by clicking "Icons on Desktop" under the Desktop section. @@ -251,8 +251,6 @@ You may now add things to your Desktop. This can be done by dragging an item ont GNOME enables the switching of workspaces via the Workspace Switcher on the right side of the Activities Overview screen. Application windows can be dragged from the Activities Overview to a workspace, whether it is empty / new, or one that already has windows in it. - - ### Keyboard Shortcuts GNOME provides a variety of keyboard shortcuts for workspaces. diff --git a/docs/user/editions/mate/configuration.md b/docs/user/editions/mate/configuration.md index 3fd60bccd..13c6bedb8 100644 --- a/docs/user/editions/mate/configuration.md +++ b/docs/user/editions/mate/configuration.md @@ -5,9 +5,9 @@ summary: Help for configuring MATE Desktop on Solus # Configuration -# System +## System -## Date and Time +### Date and time Using MATE, there are a couple of different ways to change the date and time. You can right click on the time in the bottom panel and click on "Preferences". @@ -27,7 +27,7 @@ Alternatively, if you wish to change your timezone, open the Brisk Menu and then ![MATE Timezone Settings](configuration/mate-time-and-date-settings.jpg) -## Default Applications +### Default applications Using MATE, open the Brisk Menu and click on "Preferences" and then on "Preferred Applications". @@ -59,7 +59,7 @@ Click "Apply" once you are happy with your changes. If you would like to apply t ![MATE Confirm Monitor Preferences](configuration/mate-monitor-preferences-confirm.jpg) -## Keyboard Layout +## Keyboard layout To change your keyboard layout in MATE, open the Brisk Menu and click on "Preferences" and then on "Keyboard". This will open the Keyboard Preferences window, now click on the "Layouts" tab. @@ -103,7 +103,7 @@ Or by left clicking on the keyboard layout icon shown in the system tray and sel ![MATE Bottom Panel IBus](configuration/mate-bottom-panel-ibus-left-click.jpg) -## Mouse and Touchpad +## Mouse and touchpad With MATE, open the Brisk Menu and click on "Preferences" and then on "Mouse". You can toggle between the mouse and touchpad settings using the tabs at the top of the Mouse Preferences window. Click "Close" once you have finished making changes. @@ -137,7 +137,7 @@ For touchpads, you can set: With MATE, you can manage your network settings by left or right clicking on the network icon in the bottom panel system tray. A left click will bring up any wireless or wired connections currently available whilst a right click allows you to disable networking, view your current connection information and to create new connections and networks by clicking "Edit Connections...". -### Non-Hidden Network +### Non-hidden network To connect to a network, left click on the network icon in the system tray. This will show you a selection of the networks currently available and you may need to click on "More networks" to find the one you want. @@ -153,7 +153,7 @@ Should you wish to disconnect from a network, left click on the network icon aga ![MATE Disconnect from Network](configuration/mate-network-disconnect.jpg) -### Hidden Network +### Hidden network To connect to a hidden network, left click on the network icon in the system tray and then on "Connect to Hidden Wi-Fi Network...". You will now be asked for the network name and type of security (if any). @@ -161,7 +161,7 @@ To connect to a hidden network, left click on the network icon in the system tra If the network is found and has a password, you will be prompted to authenticate with the network. -## Sound and Sound Devices +## Sound and sound devices To alter the volume in MATE, left click on the speaker icon in the bottom panel system tray and then drag the volume slider with your mouse. @@ -183,7 +183,7 @@ To add and remove users with MATE, open the Brisk Menu and click on "Administrat ![MATE Users and Groups](configuration/mate-single-user-settings.jpg) -### Adding a User +### Adding a user To add a user, click the "+ Add" button underneath the list of users. You will be asked to input your password before you can make changes. @@ -191,7 +191,7 @@ To add a user, click the "+ Add" button underneath the list of users. You will b Fill in the required items and then finish adding the new user by clicking "OK" in the bottom right corner. -### Removing a User +### Removing a user To remove a user, open the User Settings window and then click on the user you wish to remove. Now click on the "- Delete" button underneath the list of users. @@ -201,9 +201,9 @@ Upon clicking to remove the user, you will be given the option to keep their fil ![MATE Keep Files Prompt](configuration/mate-keep-files-prompt.jpg) -# User Interface +## User interface -## Desktop Background +### Desktop background If you wish to change the MATE desktop background, simply right click anywhere on the desktop and select "Change Desktop Background". @@ -215,7 +215,7 @@ In this section, you can choose between Solus wallpapers, solid colors, gradient ![MATE Desktop Background Selection](configuration/mate-background-selection.jpg) -## Desktop Icons +### Desktop icons MATE has desktop icons enabled by default. If you wish to disable or re-enable them, open the Brisk Menu, click on "Preferences" and then on "MATE Tweak". You can then toggle them on and off by clicking "Show Desktop Icons" under the Desktop section. @@ -249,7 +249,7 @@ You should now be able to see 4 slightly darker boxes to the left of your MATE s In addition to using keyboard shortcuts, you will now be able to switch workspaces by clicking on them in the bottom panel. You can also drag one workspace onto another in the bottom panel which will move the current active application to the new workspace. -### Keyboard Shortcuts +### Keyboard shortcuts MATE provides a variety of keyboard shortcuts for workspaces. By default, the keyboard shortcuts for switching directly to a certain workspace are disabled. @@ -257,7 +257,7 @@ To enable these and to also view all other available shortcuts open the Brisk Me ![MATE Workspace Keyboard Shortcuts](configuration/mate-workspace-keyboard-shortcuts.jpg) -### Workspaces Configuration +### Workspaces configuration By default, MATE provides you with 4 workspaces. If you would like to have more, less or change their names you must first add the Workspace Switcher to your bottom panel, as detailed above. You'll then be able to right click on the Workspace Switcher and select "Preferences". diff --git a/docs/user/editions/plasma/configuration.md b/docs/user/editions/plasma/configuration.md index 9a6cd03bb..ed9adbfd3 100644 --- a/docs/user/editions/plasma/configuration.md +++ b/docs/user/editions/plasma/configuration.md @@ -15,7 +15,7 @@ You can open the system settings in Solus Plasma using any of the following meth | KRunner | Press `Alt + F2` or `Alt + Space`, type `systemsettings`, and press Enter | | Terminal | Open a terminal window and execute `systemsettings` | -## Date and Time +## Date and time 1. In the [**System Settings**](#opening-system-settings) screen, go to **Personalization** > **Regional Settings** > **Date and Time**. 2. Configure the date and time of your system. @@ -33,13 +33,13 @@ You can open the system settings in Solus Plasma using any of the following meth ## Default Applications -### Configuring Default Applications from System Settings +### Configuring default applications from System Settings In the [**System Settings**](#opening-system-settings) screen, go to **Personalization** > **Applications** > **Default Applications**, then use the menus to select your preferred default applications. ![Default applications](configuration/default-apps-screen.png) -### Configuring Default Applications from the File Manager +### Configuring default applications from the file manager 1. Open Dolphin. 2. Navigate to the folder that contains the file you want to open. @@ -71,9 +71,9 @@ Press `Super + P` to access the screen layout settings. ![Screen settings available in Solus Plasma](configuration/screen-configuration.png) 4. Click **Apply**. -## Keyboard Layout +## Keyboard layout -### Configuring Keyboard Layouts +### Configuring keyboard layouts :::caution Important @@ -131,7 +131,7 @@ Some keyboard layouts require [installing additional packages](../../software/lo ::: -## Mouse and Touchpad +## Mouse and touchpad 1. In the [**System Settings**](#opening-system-settings) screen, go to the appropriate configuration screen: - To configure the mouse, go to **Input Devices** > **Mouse**. @@ -141,13 +141,13 @@ Some keyboard layouts require [installing additional packages](../../software/lo 2. Configure the available settings as needed. 3. Click **Apply**. -## Network Settings +## Network settings The **Networks** widget on the bottom panel allows you to perform frequent networking tasks, such as connecting to a Wi-Fi network or enabling airplane mode. ![Networks widget](configuration/networks-widget.png) -### Connecting to a Hidden Wi-Fi Network +### Connecting to a hidden Wi-Fi network 1. In the **System Settings** screen, go to **Network** > **Connections**. 2. Click the **Add new connection** icon (+). @@ -162,7 +162,7 @@ The **Networks** widget on the bottom panel allows you to perform frequent netwo 7. Use the **IPv4**, **IPv6** and **General configuration** tabs to configure additional settings, such as DNS servers. 8. Click **Save**. -## Sound and Sound Devices +## Sound and sound devices ![Audio Volume widget](configuration/audio-widget.png) @@ -178,7 +178,7 @@ The **Audio Volume** widget on the bottom panel allows you to perform the follow ## Users -### Adding User Accounts +### Adding user accounts 1. In the [**System Settings**](#opening-system-settings) screen, go to **Personalization** > **Users**. 2. Click **Add New User**. @@ -192,7 +192,7 @@ The **Audio Volume** widget on the bottom panel allows you to perform the follow 5. Specify your user password and click **OK**. -### Removing User Accounts +### Removing user accounts 1. In the [**System Settings**](#opening-system-settings) screen, go to **Personalization** > **Users**. 2. Select an account from the user list. @@ -201,9 +201,9 @@ The **Audio Volume** widget on the bottom panel allows you to perform the follow ![Keep or delete user files](configuration/keep-delete-files.png) -# User Interface +## User interface -## Customizing the Desktop +### Customizing the desktop The **Desktop Settings** screen allows you to customize various aspects of your desktop, such as the wallpaper and the desktop icons. To open **Desktop Settings** screen, right-click anywhere on the desktop and select **Configure Desktop and Wallpaper...**. @@ -226,7 +226,7 @@ The following table describes how to customize the desktop using the **Desktop F ::: -## Virtual Desktops +## Virtual desktops Plasma allows you to have multiple desktops on your computer. @@ -240,7 +240,7 @@ Solus Plasma has one virtual desktop and one row by default. ::: -### Creating Virtual Desktops +### Creating virtual desktops 1. In the [**System Settings**](#opening-system-settings) screen, go to **Workspace** > **Workspace Behavior** > **Virtual Desktops**. 2. Define the number of rows in the grid. @@ -269,7 +269,7 @@ Plasma displays the virtual desktop grid next to the application launcher button ::: -### Switching Between Virtual Desktops +### Switching between virtual desktops The following table outlines the methods to change between desktops in Solus Plasma. diff --git a/docs/user/editions/plasma/tips-and-tricks.md b/docs/user/editions/plasma/tips-and-tricks.md index ca52d854b..44e1b7003 100644 --- a/docs/user/editions/plasma/tips-and-tricks.md +++ b/docs/user/editions/plasma/tips-and-tricks.md @@ -5,7 +5,7 @@ summary: Helpful tips and tricks for using Plasma on Solus. # Tips and Tricks -## Keyboard Shortcuts +## Keyboard shortcuts :::tip @@ -15,7 +15,7 @@ To see the complete list of keyboard shortcuts available on your system, open th The following table shows some of the keyboard shortcuts available in Solus Plasma. -| Keyboard Shortcut | Action | +| Keyboard shortcut | Action | | --------------------------- | ---------------------------------------------------------------------- | | `Alt` + `F2` | Opens KRunner | | `Alt` + `Space` | Opens KRunner | @@ -75,7 +75,7 @@ The following table describes some of the keyboard shortcuts you can use in Dolp | Show/hide the side panel | Press `F9` to show/hide the **Places** side panel. | | Switch between the view modes | Press `Ctrl` + `1` to display icons in _icons_ view, press `Ctrl` + `2` to display icons in _compact_ view, or press `Ctrl` + `3` to display icons in _details_ view; | -## Context Menu +## Context menu The _Plasma_ desktop provides a variety of context menus. Context menus display options, settings, and actions applicable to the current context or element you select. diff --git a/docs/user/hardware/compatibility/laptops.md b/docs/user/hardware/compatibility/laptops.md index cdf9dd270..fb388f3ea 100644 --- a/docs/user/hardware/compatibility/laptops.md +++ b/docs/user/hardware/compatibility/laptops.md @@ -38,7 +38,7 @@ This list should not suggest that _only_ such devices listed below are compatibl - Apple Macbook (late 2008) - Apple MacBookPro8,3 -## Asus +## ASUS - Asus EEE-PC 1001PX - Asus EEE-PC 1011PX @@ -101,9 +101,9 @@ This list should not suggest that _only_ such devices listed below are compatibl - Fujitsu Lifebook A531 - Fujitsu Lifebook T900 -## Gigabyte +## GIGABYTE -- Gigabyte Aero 14K +- GIGABYTE Aero 14K ## Google diff --git a/docs/user/hardware/index.md b/docs/user/hardware/index.md index 3b63d4ac2..4d463e681 100755 --- a/docs/user/hardware/index.md +++ b/docs/user/hardware/index.md @@ -5,7 +5,7 @@ summary: Guide to using additional hardware on Solus # Hardware -## Preinstalled Drivers +## Preinstalled drivers The vast majority of hardware on Linux is supported by driver modules included with the Linux Kernel. This includes things like: @@ -21,47 +21,47 @@ The purpose of this documentation is to help you find drivers for hardware that The situations with GPU drivers on Linux is a little complicated. Each driver is actually broken up into multiple pieces: -- **Direct Rendering Manager (DRM)** - This is the part of the driver provided by the Linux Kernel and provides just enough functionality to allow other drivers to access the hardware and render to a connected display. - Linux provides support for AMD, Intel, and Nvidia GPUs in this basic capacity. -- **OpenGL Driver** +- **Direct Rendering Manager (DRM)** + This is the part of the driver provided by the Linux kernel and provides just enough functionality to allow other drivers to access the hardware and render to a connected display. + Linux provides support for AMD, Intel, and NVIDIA GPUs in this basic capacity. +- **OpenGL driver** This part of the driver is needed for OpenGL applications. AMD and Intel are fully supported on Linux through Mesa, and do not need further drivers. -- **Vulkan Driver** +- **Vulkan driver** This part of the driver is needed for Vulkan applications. AMD and Intel are fully supported on Linux through Mesa, and do not need further drivers. -- **Xorg Driver** +- **Xorg driver** In order to expose certain features to the Xorg Server, AMD and Intel have additional drivers which may be needed for things like variable refresh rate or multiple display support. -Unfortunately for Nvidia users, the situation gets a little complicated. Linux has two sets of drivers for Nvidia GPUs: +Unfortunately for NVIDIA users, the situation gets a little complicated. Linux has two sets of drivers for NVIDIA GPUs: -- **Nouveau** - This is the open-source driver for Nvidia GPUs. It consists of a DRM Driver provided by the Linux Kernel, OpenGL Drivers (nvc0, nv50) from Mesa, and an Xorg Driver (xorg-driver-video-nouveau). - Device support for these drivers has historically lagged behind the Nvidia proprietary drivers and likely will not support newer hardware and does not include Vulkan support. +- **Nouveau** + This is the open-source driver for NVIDIA GPUs. It consists of a DRM driver provided by the Linux kernel, OpenGL drivers (nvc0, nv50) from Mesa, and an Xorg driver (xorg-driver-video-nouveau). + Device support for these drivers has historically lagged behind the NVIDIA proprietary drivers and likely will not support newer hardware and does not include Vulkan support. Performance of this driver also typically lags behind the proprietary drivers. -- **Nvidia Proprietary Drivers** - This is the closed-source driver provided directly from Nvidia. It consists of a DRM driver module for the kernel, OpenGL and Vulkan drivers for rendering, and additional drivers for extended features of the hardware. - Device support for these drivers is very good for newer hardware, but older devices will eventually become unsupported and require the Nouveau drivers instead. +- **NVIDIA proprietary drivers** + This is the closed-source driver provided directly by NVIDIA. It consists of a DRM driver module for the kernel, OpenGL and Vulkan drivers for rendering, and additional drivers for extended features of the hardware. + Device support for these drivers is very good for newer hardware, but older devices will eventually become unsupported and require the Nouveau drivers instead. Performance of this driver is typically the best available and is therefore highly desirable to gamers and content creators. -## Proprietary Drivers +## Proprietary drivers Installing proprietary drivers may improve performance or certain features, however they are usually not necessary for normal daily usage. Solus provides a utility for installing drivers for detected hardware. ![DoFlicky Screenshot](doflicky.jpg) -If there are proprietary drivers that can be installed, they will show up in the box below the description. You can click the item you wish to install and click Install. If you are installing NVIDIA drivers, you may find it to be desirable to install the 32-bit driver as well, in the event you wish to use Steam or WINE. +If there are proprietary drivers that can be installed, they will show up in the box below the description. You can click the item you wish to install and click Install. If you are installing NVIDIA drivers, you may find it to be desirable to install the 32-bit driver as well, in the event you wish to use Steam or Wine. **Note:** A reboot will be required to use the newly installed driver. -### Supported Drivers +### Supported drivers | Vendor | Drivers | | ----------- | ---------------- | -| Asus | piper | +| ASUS | piper | | Broadcom | broadcom-sta | | Logitech | piper | -| Nvidia | 470, Main Series | +| NVIDIA | 470, main series | | Razer | openrazer | | Roccat | piper | | SteelSeries | piper | -| VMWare | open-vm-tools | -| XBox | xone | +| VMware | open-vm-tools | +| Xbox | xone | diff --git a/docs/user/hardware/mobile/android.md b/docs/user/hardware/mobile/android.md index 544621979..401f1cb29 100644 --- a/docs/user/hardware/mobile/android.md +++ b/docs/user/hardware/mobile/android.md @@ -5,13 +5,13 @@ summary: Quick guide to working with Android devices on Solus # Android -For the most part, Android devices will work out of the box on Solus. The experience is similar to on other operating systems. +For the most part, Android devices will work out of the box on Solus. The experience is similar to other operating systems. -## File Management +## File management TODO: Tutorial on accessing files from a file browser. Android screenshots would be nice to have. -## Developer Tools +## Developer tools Whether you are an Android developer or just need `adb` or `fastboot` for installing a ROM, we've got you covered! We just need to install `android-tools` from the Software Center or command-line: diff --git a/docs/user/hardware/mobile/apple.md b/docs/user/hardware/mobile/apple.md index e233bbc8c..bfe766d28 100644 --- a/docs/user/hardware/mobile/apple.md +++ b/docs/user/hardware/mobile/apple.md @@ -5,7 +5,7 @@ summary: Quick guide to working with Apple devices on Solus # Apple -Solus provides iOS support via [libimobiledevice](https://www.libimobiledevice.org/) and [libgpod](https://github.com/fadingred/libgpod/). +Solus provides iOS support via [libimobiledevice](https://libimobiledevice.org/) and [libgpod](https://github.com/fadingred/libgpod/). Please note that the below mentioned installation instructions do not guarantee functional iOS features such as content synchronization (music) or file copying. @@ -21,6 +21,6 @@ sudo eopkg install libideviceactivation **NOTE:** It is recommended that you reboot your system after this installation. -## File Management +## File management TODO: Tutorial on file access and syncing diff --git a/docs/user/hardware/peripherals/mice-and-touchpads.md b/docs/user/hardware/peripherals/mice-and-touchpads.md index ea3ce8de5..4a79e4b1f 100644 --- a/docs/user/hardware/peripherals/mice-and-touchpads.md +++ b/docs/user/hardware/peripherals/mice-and-touchpads.md @@ -5,7 +5,7 @@ summary: Guide to using and configuring input devices on Solus # Mice and Touchpads -## Asus, Logitech, Roccat, SteelSeries +## ASUS, Logitech, Roccat, SteelSeries TODO: Quick tutorial on installing `piper` with a screenshot. And point them at the official documentation. @@ -49,7 +49,7 @@ cat /var/log/Xorg.0.log | grep "Using input driver 'synaptics' for" If it returns a result, then success! The synaptics driver is in use instead of libinput for your Touchpad. -### Revert Configuration +### Revert configuration If you wish to switch back to using libinput: diff --git a/docs/user/hardware/peripherals/midi-keyboard.md b/docs/user/hardware/peripherals/midi-keyboard.md index 81c48bbf7..dc894e8b4 100644 --- a/docs/user/hardware/peripherals/midi-keyboard.md +++ b/docs/user/hardware/peripherals/midi-keyboard.md @@ -5,15 +5,15 @@ summary: Guide for installing and configuring MIDI keyboards on Solus # MIDI Keyboards -These instructions will guide you through how to set up and use a USB-connected MIDI Keyboard on Solus. This will easily let you use the keyboard to play music with a wide set of instruments. +These instructions will guide you through how to set up and use a USB-connected MIDI keyboard on Solus. This will easily let you use the keyboard to play music with a wide set of instruments. ## Installing required software We will need to install three packages in order to use the keyboard: -1. `qsynth` - A frontend for fluidsynth +1. `qsynth` - A frontend for `fluidsynth` 2. `qjackctl` - A controller for the JACK audio server -3. `fluid-soundfont` - An open source soundfont to use with fluidsynth +3. `fluid-soundfont` - An open source soundfont to use with `fluidsynth` ```bash sudo eopkg it qsynth qjackctl fluid-soundfont diff --git a/docs/user/hardware/peripherals/printers-and-scanners.md b/docs/user/hardware/peripherals/printers-and-scanners.md index ac0313e70..4cb604393 100644 --- a/docs/user/hardware/peripherals/printers-and-scanners.md +++ b/docs/user/hardware/peripherals/printers-and-scanners.md @@ -66,9 +66,9 @@ Should your printer not be on this list, and the generic `brlaser` driver does n You can connect your Brother scanner via USB or LAN to be able to scan. To get newer Brother scanners to work you will have to install the package `brscan4` -### Network Scanner +### Network scanner -If your scanner is networks, you need to tell `saned` the IP of your printer. It's advised to give your printer always the same IP inside your Network (ie. Static IP Address). Run the following command to accomplish this: +If your scanner is networked, you need to tell `saned` the IP of your printer. It's advised to always give your printer the same IP inside your network (that is, a static IP address). Run the following command to accomplish this: ```bash brsaneconfig4 -a name=SCANNER model=$MODEL ip=$IPOFYOURSCANNER diff --git a/docs/user/package-management/basics.md b/docs/user/package-management/basics.md index 6de8a05c0..dbea73a89 100755 --- a/docs/user/package-management/basics.md +++ b/docs/user/package-management/basics.md @@ -8,7 +8,7 @@ summary: Basics to Package Management Solus uses the eopkg package management system to deliver software to the end-user. Below are some basic commands for using eopkg. -## Installing Software +## Installing software You can install one or more packages by using: @@ -22,7 +22,7 @@ For example: sudo eopkg install gnome-documents gnome-music ``` -## Reinstalling Software +## Reinstalling software You can reinstall one or more packages by using: @@ -36,7 +36,7 @@ For example: sudo eopkg install --reinstall gnome-documents gnome-music ``` -## Uninstalling Software +## Uninstalling software You can uninstall one or more packages by using: @@ -50,7 +50,7 @@ For example: sudo eopkg remove gnome-documents gnome-music ``` -## Get Information on Software +## Get information on software You can get information on software, such as its description, version, installation size, and more, by using @@ -94,12 +94,12 @@ 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. -## Base Development Tools +## Base development tools -If you are wanting to compile software under Solus, we recommend installing our system.devel component by running the following: +If you are wanting to compile software under Solus, we recommend installing our `system.devel` component by running the following: ```bash sudo eopkg install -c system.devel ``` -This will provide items such as clang, gcc, make, a multitude of devel sub-packages, and more. Our system.devel is similar to packages on other operating systems, such as Debian's build-essentials. +This will provide items such as `clang`, `gcc`, `make`, a multitude of devel sub-packages, and more. Our `system.devel` is similar to packages on other operating systems, such as Debian's build-essentials. diff --git a/docs/user/package-management/history-and-rollback.md b/docs/user/package-management/history-and-rollback.md index 33c27ee45..3ec251f6e 100755 --- a/docs/user/package-management/history-and-rollback.md +++ b/docs/user/package-management/history-and-rollback.md @@ -5,13 +5,13 @@ summary: History and Software Rollback # History and Software Rollback -Solus provides a history and rollback feature via its package manager, eopkg. This feature allows you to see when your repository was last updated, actions such as installation, removal, and upgrading of software. +Solus provides a history and rollback feature via its package manager, `eopkg`. This feature allows you to see when your repository was last updated, actions such as installation, removal, and upgrading of software. Our rollback feature allows you to essentially rewind your system's software back to a previous state, assuming you or our repository has the versions in question. ## History -You can see the history from eopkg by using: +You can see the history from `eopkg` by using: ```bash eopkg history diff --git a/docs/user/package-management/repo-management.md b/docs/user/package-management/repo-management.md index 1375178d6..4986cfa7a 100755 --- a/docs/user/package-management/repo-management.md +++ b/docs/user/package-management/repo-management.md @@ -7,7 +7,7 @@ summary: Repository Management While Solus currently only provides two repositories, stable (shannon) and unstable, our package manager does support actively using multiple repositories on your system. This is useful if you are using a vendor-provided repository. -## Official Solus Repositories +## Official Solus repositories The official Solus repositories are: @@ -22,12 +22,12 @@ It is not always safe to perform a system update when using the **unstable** rep ::: -## Adding a Repository +## Adding a repository You can add a repository by using: ```bash -sudo eopkg add-repo Name Url +sudo eopkg add-repo Name URL ``` For example: @@ -38,7 +38,7 @@ sudo eopkg add-repo Example https://example.com/repo/eopkg-index.xml.xz **Note:** This does not enable the repository. -## Removing a Repository +## Removing a repository You can remove a repository by using: @@ -52,7 +52,7 @@ For example: sudo eopkg remove-repo Example ``` -## Enabling a Repository +## Enabling a repository You can enable a repository for usage, by using: @@ -66,7 +66,7 @@ For example: sudo eopkg enable-repo Example ``` -## Disabling a Repository +## Disabling a repository You can disable a repository by using: @@ -80,7 +80,7 @@ For example: sudo eopkg disable-repo Example ``` -## Updating a Repository +## Updating a repository You can update the index of a repository by using: diff --git a/docs/user/privacy.md b/docs/user/privacy.md index 53a17e021..cd72564a1 100644 --- a/docs/user/privacy.md +++ b/docs/user/privacy.md @@ -1,12 +1,12 @@ # Privacy Policy -## Solus Installations +## Solus installations - Solus does not collect or store data from user's machines. - Solus does not use telemetry or automatic error reporting. - Some packages may include their own built-in telemetry (examples: Firefox, Steam). Solus cannot control data collected in this way. These packages may allow you to disable this telemetry. -## Solus Forum (discuss.getsol.us) +## Solus forum (discuss.getsol.us) - You may view the forum without providing personal data - Cookies are used to store login information @@ -16,7 +16,7 @@ - (optional) _Third party login information_ to allow signing in using an SSO provider like _GitHub_. - This information will be retained and processed to authenticate logins. The information will be retained until you delete your account. -### Third Party Hosts +### Third party hosts Solus cannot control how data is collected and processed on the third party hosts we use. We use the following hosts: @@ -25,21 +25,21 @@ Solus cannot control how data is collected and processed on the third party host - The Solus package mirror `cdn.getsol.us` is hosted by Cloudflare - [Cloudflare Privacy Policy](https://www.cloudflare.com/privacypolicy/) -#### Github +#### GitHub -- The Solus homepage `getsol.us`, and the help center `help.getsol.us` are hosted by Github Pages -- Solus repositories are hosted on Github under the [`getsolus` organization](https://github.com/getsolus/) -- [Github Privacy Policy](https://docs.github.com/en/site-policy/privacy-policies/github-privacy-statement) +- The Solus homepage `getsol.us`, and the help center `help.getsol.us` are hosted by GitHub Pages +- Solus repositories are hosted on GitHub under the [`getsolus` organization](https://github.com/getsolus/) +- [GitHub Privacy Policy](https://docs.github.com/en/site-policy/privacy-policies/github-general-privacy-statement) #### Matrix -- The Solus matrix rooms are hosted by the Matrix.org homeserver +- The Solus Matrix rooms are hosted by the Matrix.org homeserver - [Matrix.org Homeserver Privacy Notice](https://matrix.org/legal/privacy-notice) ## Your rights under the GDPR -If you are covered by the [GDPR](https://gdpr.eu/) you have rights as a data subject. Your rights are detailed under [Chapter 3 of the GDPR](https://gdpr.eu/article-12-how-controllers-should-provide-personal-data-to-the-subject/). Additionally, you have the right to lodge a complaint with your national [Data Protection Authority](https://edpb.europa.eu/about-edpb/board/members_en). +If you are covered by the [GDPR](https://gdpr.eu/) you have rights as a data subject. Your rights are detailed under [Chapter 3 of the GDPR](https://gdpr.eu/article-12-how-controllers-should-provide-personal-data-to-the-subject/). Additionally, you have the right to lodge a complaint with your national [Data Protection Authority](https://www.edpb.europa.eu/about-edpb/about-edpb/members_en). -## Privacy Contact +## Privacy contact Any concerns or requests about personal data should be sent to [privacy@getsol.us](mailto:privacy@getsol.us) diff --git a/docs/user/quick-start/boot-management.md b/docs/user/quick-start/boot-management.md index ade8c0b25..c8fc9ff56 100644 --- a/docs/user/quick-start/boot-management.md +++ b/docs/user/quick-start/boot-management.md @@ -5,27 +5,27 @@ summary: Guide to customizing the Solus boot process # Boot Management -# clr-boot-manager +## clr-boot-manager -Solus leverages `clr-boot-manager` from the ClearLinux project to manage its boot process. +Solus leverages `clr-boot-manager` from the Clear Linux\* project to manage its boot process. On legacy BIOS systems, `clr-boot-manager` will configure `GRUB2` to properly boot your system. On modern UEFI systems, `clr-boot-manager` will configure `systemd-boot` instead. This means that any time we want to modify the boot process, `clr-boot-manager` will be involved. Trying to modify the configurations manually may work temporarily, but will be overwritten eventually. -## Open the boot menu +### Open the boot menu By default, EFI installs will not show the boot menu and boot directly into Solus. By hitting space bar (repeatedly) during boot, the boot menu will appear (it may take a couple of goes to get the timing right). -## Displaying the boot menu by default every boot +### Displaying the boot menu by default every boot -The following command will set the timeout of the boot loader so that it appears by default. +The following command will set the timeout of the boot loader to five seconds so that it appears by default: ``` sudo clr-boot-manager set-timeout 5 && sudo clr-boot-manager update ``` -## Adding kernel parameters +### Adding kernel parameters Kernel parameters can be appended to boot via creating a file for `clr-boot-manager` to use when updating kernels. For example, to add `nomodeset` to boot options, you would create a file in `/etc/kernel/cmdline.d` (as sudo): @@ -36,9 +36,9 @@ echo 'nomodeset' | sudo tee /etc/kernel/cmdline.d/40_nomodeset.conf The settings should be on one line with a space between them. You will need to run `sudo clr-boot-manager update` for the options to be appended to boot. -# Kernels +## Kernels -## Installing a different kernel branch +### Installing a different kernel branch By default, Solus utilizes our linux-current kernel. The separate kernel branches can be added by installing the `linux-lts` or `linux-current` packages. Note that each kernel has separate module packages, so if you use these kernel modules, you'll need to install the one related to the kernel you are adding. @@ -56,6 +56,6 @@ By default, Solus utilizes our linux-current kernel. The separate kernel branche | vhba-module | vhba-module-current | | virtualbox | virtualbox-current | -## Change the default kernel branch to boot +### Change the default kernel branch to boot After successfully booting into a kernel from the `current` or `lts` branches running `sudo clr-boot-manager update` will make the booted kernel branch the default boot option going forward. diff --git a/docs/user/quick-start/installation/index.md b/docs/user/quick-start/installation/index.md index 8ee84be43..7dc6cd1df 100755 --- a/docs/user/quick-start/installation/index.md +++ b/docs/user/quick-start/installation/index.md @@ -48,7 +48,7 @@ sha256sum -c Solus-4.5-Budgie.iso.sha256sum | grep OK #### Verifying signed SHA256SUM file -On Windows, first install [gpg4win](https://www.gpg4win.org/). +On Windows, first install [Gpg4win](https://www.gpg4win.org/). Now you can run the same `gpg` commands from the the [_Verifyng the SHA256SUMS file signature_](/docs/user/quick-start/installation/index.md#verifying-the-sha256sums-file-signature) section above. @@ -61,7 +61,7 @@ Get-FileHash C:\path\to\Solus-4.5-Budgie.iso cat C:\path\to\Solus-4.5-Budgie.iso.sha256sum ``` -Alternatively, you can use a graphical program that can calculate SHA256 hashes like _Rufus_ or _7zip_. +Alternatively, you can use a graphical program that can calculate SHA256 hashes like _Rufus_ or _7-Zip_. ## Creating bootable media @@ -69,7 +69,7 @@ To make boot media, you will need: 1. Either a blank DVD or a USB drive larger than 2 GB. 2. If using a USB, the ability to boot from the USB. -3. ISO file from the _Getting the ISO_ section. +3. ISO file from the [Getting the ISO](#getting-the-iso) section. There are many tools which can write our ISO image to DVDs or USB thumb drives. Chose from an option below. @@ -89,7 +89,7 @@ We recommend using [Brasero](https://wiki.gnome.org/Apps/Brasero) for writing th #### USB -We recommend using [GNOME MultiWriter](https://wiki.gnome.org/Apps/MultiWriter) or [ISO Image Writer](https://apps.kde.org/isoimagewriter/) for KDE. Please note that unetbootin will **not** work. +We recommend using [GNOME MultiWriter](https://wiki.gnome.org/Apps/MultiWriter) or [ISO Image Writer](https://apps.kde.org/isoimagewriter/) for KDE. Please note that UNetbootin will **not** work. ##### GNOME MultiWriter @@ -178,7 +178,7 @@ This will write the contents of the ISO to the thumb drive so you can boot it an You can easily burn an ISO image to a DVD, on Windows 7 and newer, by using Window's built-in file manager (Explorer). -1. Open Window's built-in file manager (Explorer). +1. Open Windows' built-in file manager (Explorer). 2. Right click on the ISO image file and click "Burn disk image". 3. Select the correct disc burner. 4. Click "Burn". diff --git a/docs/user/quick-start/installation/secure-boot.md b/docs/user/quick-start/installation/secure-boot.md index a98692238..f8461e960 100644 --- a/docs/user/quick-start/installation/secure-boot.md +++ b/docs/user/quick-start/installation/secure-boot.md @@ -9,7 +9,7 @@ Since Solus 4.4 secure boot is now supported. When you first boot the ISO, and, 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. -## Enrolling the Solus Certificate +## 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. @@ -35,7 +35,7 @@ Now, with the Solus certificate enrolled, press `Enter` to reboot the machine, b Once Solus is installed you will not have to enroll the certificate again as it will stay enrolled. -## Enabling Secure Boot on an Existing Install +## 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. @@ -58,7 +58,7 @@ Once you've found and enabled the Secure Boot setting then reboot once again fro Remember to save settings after enabling Secure Boot! (usually `F10`) -### Final Tips +### Final tips Once you've successfully enabled and booted your Solus install with Secure Boot enabled. Go back into your machine's UEFI firmware interface and change the default boot device to `Solus Linux Bootloader`. @@ -66,7 +66,7 @@ You can run `bootctl status | grep "Secure Boot"` in a terminal to verify Secure 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? +# Why is enrolling the Solus certificate necessary? In order to avoid the one time step of enrolling the Solus certificate, Solus would have to get it's own `shim` EFI executable signed by Microsoft. Currently, the following actions must be completed to do this: @@ -85,7 +85,7 @@ However, it is also important to consider the following: 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. -## Useful Links for Additional Reading +## Useful links for additional reading - https://learn.microsoft.com/windows-hardware/drivers/dashboard/file-signing-reqs - https://github.com/rhboot/shim-review/ diff --git a/docs/user/software/camera/droidcam.md b/docs/user/software/camera/droidcam.md index 18fcfc702..0630fab0a 100644 --- a/docs/user/software/camera/droidcam.md +++ b/docs/user/software/camera/droidcam.md @@ -7,7 +7,7 @@ summary: Quick Start guide to DroidCam on Solus [DroidCam](https://www.dev47apps.com/) turns your phone or tablet into a webcam for your computer. You can use it with video conferencing programs like Zoom, MS Teams, and Skype. -## Before Installation +## Before installation DroidCam relies on the v4l2loopback kernel module. So you need to install `v4l2loopback` or `v4l2loopback-current` depending of which kernel is installed on your computer. To find out which kernel is installed, run: diff --git a/docs/user/software/development/containers.md b/docs/user/software/development/containers.md index a853edc87..1197373c5 100644 --- a/docs/user/software/development/containers.md +++ b/docs/user/software/development/containers.md @@ -1,6 +1,6 @@ # Containers -Containers are a popular method to run and configure applications in a confined environment without directly installing the application and all it's dependencies. Solus provides the following container technologies: +Containers are a popular method to run and configure applications in a confined environment without directly installing the application and all its dependencies. Solus provides the following container technologies: ## Docker diff --git a/docs/user/software/development/index.md b/docs/user/software/development/index.md index 7109e9827..e828383a8 100755 --- a/docs/user/software/development/index.md +++ b/docs/user/software/development/index.md @@ -9,7 +9,7 @@ Solus provides a stable foundation for creating, testing, and deploying applicat You can install tools such as text editors, programming languages, compilers, and version control systems. Solus also supports containerization and virtualization technologies. -## Getting Started +## Getting started If you want to compile and develop software using Solus, we recommend installing the `system.devel` component. @@ -33,9 +33,9 @@ Learn how to install, run, and manage Java on Solus. A quick guide to using PostgreSQL on Solus. -[**R and R Studio**](r-and-rstudio) +[**R and RStudio**](r-and-rstudio) -Quick start guide for R and R Studio on Solus. +Quick start guide for R and RStudio on Solus. [**Rust**](rust) diff --git a/docs/user/software/development/java.md b/docs/user/software/development/java.md index bcf405d11..37e6fa4e3 100644 --- a/docs/user/software/development/java.md +++ b/docs/user/software/development/java.md @@ -21,8 +21,9 @@ The following table lists the versions of Java available in the Solus repositori | ------- | ------------ | ----------------------- | ------------------- | ----- | | Java 11 | `openjdk-11` | `/usr/lib64/openjdk-11` | JRE, JDK, OpenJFX | | | Java 17 | `openjdk-17` | `/usr/lib64/openjdk-17` | JRE, JDK | | +| Java 21 | `openjdk-21` | `/usr/lib64/openjdk-21` | JRE, JDK | | -## Running Java Applications +## Running Java applications :::caution Important @@ -34,5 +35,5 @@ There are multiple ways to execute Java applications in Solus: - Create a .desktop file, then add `env JAVA_HOME=/path/to/jdk/bin` to Exec. - Create a script that sets `JAVA_HOME` before running the application. -- Symlink the java executable from `/path/to/jdk/bin` to `/usr/bin`. +- Symlink the `java` executable from `/path/to/jdk/bin` to `/usr/bin`. - Add `/path/to/jdk/bin` to your PATH environment variable. diff --git a/docs/user/software/development/r-and-rstudio.md b/docs/user/software/development/r-and-rstudio.md index 4ea070fbc..64123f0b0 100644 --- a/docs/user/software/development/r-and-rstudio.md +++ b/docs/user/software/development/r-and-rstudio.md @@ -1,26 +1,26 @@ --- -title: R and Rstudio -summary: Quick start guide for R and Rstudio on Solus +title: R and RStudio +summary: Quick start guide for R and RStudio on Solus --- -# R and Rstudio +# R and RStudio -Covers the basics of how to install R and Rstudio on Solus and also covers how to install required dependencies for installing additional CRAN libraries. +Covers the basics of how to install R and RStudio on Solus and also covers how to install required dependencies for installing additional CRAN libraries. ## Downloading R -It is recommended to download R before downloading Rstudio. This can be accomplished easily in any of three ways. -**NOTE:** Both R and Rstudio are available natively on Solus thanks to their amazing maintainers, it is not necessary to go to either softwares' respective website. +It is recommended to download R before downloading RStudio. This can be accomplished easily in any of three ways. +**NOTE:** Both R and RStudio are available natively on Solus thanks to their amazing maintainers, it is not necessary to go to either software's respective website. - The easiest way to do this is to search for R within the **Software Center** - Alternatively you can enter the **Software Center**, select **Programming Languages & Tools**, then select **Programming** and scroll down until you see **r**. _The list itself is in alphabetical order so it will be near the bottom._ - The third option for install is to open your terminal and enter the command `sudo eopkg it r` -## Downloading Rstudio +## Downloading RStudio -The first step in setting up Rstudio is to download and install it. This can be accomplished in the same ways as R in the prior step. +The first step in setting up RStudio is to download and install it. This can be accomplished in the same ways as R in the prior step. -- The easiest way to do this is to search for Rstudio within the **Software Center** +- The easiest way to do this is to search for RStudio within the **Software Center** - Alternatively you can enter the **Software Center**, select **Programming Languages & Tools**, then select **Integrated Development Environments** and scroll down until you see **r**. _The list itself is in alphabetical order so it will be near the bottom._ - The third option for install is to open your terminal and enter the command `sudo eopkg it rstudio` @@ -28,7 +28,7 @@ The first step in setting up Rstudio is to download and install it. This can be Unless you are only going to use base R functions, you will need to make use of `install.package()` within R to install additional libraries. To use this function within R you need to install certain development packages which vary depending on the library you are trying to enable within R. -On other linux distros (like debian, ubuntu, and fedora) this is accomplished through the installation of r-devel. However since Solus does not have an r-devel package these dependencies have to be installed through other means. +On other Linux distros (like Debian, Ubuntu, and Fedora) this is accomplished through the installation of r-devel. However since Solus does not have an r-devel package these dependencies have to be installed through other means. There two main solus packages that will include many of the dependencies required that allow you to install most R CRAN packages. These are `system.devel` and `curl-devel`. @@ -39,7 +39,7 @@ Once these two Solus packages are installed `install.package()` will work as usu If when you try to install a CRAN library with `install.package()` from within R and you are presented with an error that says `...exited with non zero exit status` this is most likely because one of the required dependencies, _which will be listed within the R console detailing the error_, is contained within a Solus devel package you have not yet installed. -#### Additional Discovered Dependencies +#### Additional discovered dependencies This section should be edited to help future users to know what Solus devel packages are needed to install additional, more specialized CRAN packages. diff --git a/docs/user/software/development/rust.md b/docs/user/software/development/rust.md index 129cff6cd..a512bc815 100644 --- a/docs/user/software/development/rust.md +++ b/docs/user/software/development/rust.md @@ -20,4 +20,4 @@ The `rust` package, in fact, is present in the Solus repository for building pac Either way, it is also recommended to install our `system.devel` component, which is typically required for compiling. See our documentation for it [here](/docs/user/software/development). -As a final note, it is possible to [configure](https://rust-lang.github.io/rustup/installation/package-managers.html) `rustup` to use the system toolchain. This setup is **discouraged** unless aimed at developing applications targeting Solus itself. +As a final note, it is possible to [configure](https://rust-lang.github.io/rustup/installation/already-installed-rust.html) `rustup` to use the system toolchain. This setup is **discouraged** unless aimed at developing applications targeting Solus itself. diff --git a/docs/user/software/development/web.md b/docs/user/software/development/web.md index 25f4b9a90..7d6a0af0a 100644 --- a/docs/user/software/development/web.md +++ b/docs/user/software/development/web.md @@ -72,7 +72,7 @@ If you modify the configuration files located in the `/usr/share/defaults/httpd/ The document root is the directory where Apache serves files from. By default, the document root is `/var/www/`. -#### Enabling PHP Support +#### Enabling PHP support 1. Install `php` from the Software Center or execute the following command: `sudo eopkg install php`. 2. Create a new `/etc/httpd/conf.d/php.conf` file with the following contents: diff --git a/docs/user/software/localization/ibus.md b/docs/user/software/localization/ibus.md index f7242764a..b1490e0fc 100755 --- a/docs/user/software/localization/ibus.md +++ b/docs/user/software/localization/ibus.md @@ -7,7 +7,7 @@ summary: Configuration of additional languages via IBUS ## Configuration -Find the IME (Input Method Editor) you require from the [IBus IME Package List](#ibus-ime-package-list) and then search for it in the Software Center. Click "Install" to add the IME. +Find the IME (Input Method Editor) you require from the [IBus IME package list](#ibus-ime-package-list) and then search for it in the Software Center. Click "Install" to add the IME. ![IBus IME Install](./ibus/ibus-ime-install.jpg) @@ -23,17 +23,17 @@ Additionally, once you have added the IME and have it selected in the Region & L ![IBus IME Settings Example: Hangul](./ibus/ibus-ime-settings-hangul.jpg) -## IBus IME Package List +## IBus IME package list A list of IBus IME packages available in the Solus software repository. -| Package | Input Method | -| ------------ | --------------------------------------------------- | -| Anthy | Japanese | -| ibus-chewing | Phonetic Chinese input method for Zhuyin (Bopomofo) | -| ibus-hangul | Korean | -| ibus-m17n | Multiple Languages | -| ibus-unikey | Vietnamese | -| Pinyin | Chinese Pinyin and Bopomofo | -| Zhuyin | Chinese Zhuyin | -| Quick | Simplified Cangjie | +| Package | Input Method | +| -------------- | --------------------------------------------------- | +| ibus-anthy | Japanese | +| ibus-chewing | Phonetic Chinese input method for Zhuyin (Bopomofo) | +| ibus-hangul | Korean | +| ibus-m17n | Multiple Languages | +| ibus-unikey | Vietnamese | +| ibus-libpinyin | Chinese Pinyin and Bopomofo | +| ibus-libzhuyin | Chinese Zhuyin | +| ibus-cangjie | Simplified Cangjie | diff --git a/docs/user/software/sound/index.md b/docs/user/software/sound/index.md index 249632436..c87929b58 100644 --- a/docs/user/software/sound/index.md +++ b/docs/user/software/sound/index.md @@ -5,4 +5,4 @@ summary: Configuration of sound systems on Solus # Sound -Solus comes with Pipewire configured by default. +Solus comes with PipeWire configured by default. diff --git a/docs/user/software/third-party/index.md b/docs/user/software/third-party/index.md index 07e2cc84c..25e034fed 100644 --- a/docs/user/software/third-party/index.md +++ b/docs/user/software/third-party/index.md @@ -66,7 +66,7 @@ sudo eopkg bi --ignore-safety https://raw.githubusercontent.com/getsolus/3rd-par sudo eopkg it bitwig-studio*.eopkg;sudo rm bitwig-studio*.eopkg ``` -### OcenAudio +### Ocenaudio ```bash sudo eopkg bi --ignore-safety https://raw.githubusercontent.com/getsolus/3rd-party/master/multimedia/music/ocenaudio/pspec.xml @@ -88,7 +88,7 @@ sudo systemctl start plexmediaserver.service sudo systemctl enable plexmediaserver.service ``` -### Sunvox +### SunVox ```bash sudo eopkg bi --ignore-safety https://raw.githubusercontent.com/getsolus/3rd-party/master/multimedia/music/sunvox/pspec.xml @@ -193,14 +193,14 @@ sudo eopkg bi --ignore-safety https://raw.githubusercontent.com/getsolus/3rd-par sudo eopkg it clion*.eopkg;sudo rm clion*.eopkg ``` -### Datagrip +### DataGrip ```bash sudo eopkg bi --ignore-safety https://raw.githubusercontent.com/getsolus/3rd-party/master/programming/datagrip/pspec.xml sudo eopkg it datagrip*.eopkg;sudo rm datagrip*.eopkg ``` -### Git Kraken +### GitKraken ```bash sudo eopkg bi --ignore-safety https://raw.githubusercontent.com/getsolus/3rd-party/master/programming/gitkraken/pspec.xml @@ -214,14 +214,14 @@ sudo eopkg bi --ignore-safety https://raw.githubusercontent.com/getsolus/3rd-par sudo eopkg it idea*.eopkg;sudo rm idea*.eopkg ``` -### PHPStorm +### PhpStorm ```bash sudo eopkg bi --ignore-safety https://raw.githubusercontent.com/getsolus/3rd-party/master/programming/phpstorm/pspec.xml sudo eopkg it phpstorm*.eopkg;sudo rm phpstorm*.eopkg ``` -### Pycharm +### PyCharm ```bash sudo eopkg bi --ignore-safety https://raw.githubusercontent.com/getsolus/3rd-party/master/programming/pycharm/pspec.xml diff --git a/docs/user/software/virtualization/virtualbox.md b/docs/user/software/virtualization/virtualbox.md index f1b6ef3cf..92aa495a5 100644 --- a/docs/user/software/virtualization/virtualbox.md +++ b/docs/user/software/virtualization/virtualbox.md @@ -40,29 +40,29 @@ uname -r You will either have a `.current` or `.lts` suffix. Examples: `5.13.1-187.current` or `4.14.237-175.lts` -## Solus as Host +## Solus as host VirtualBox is available in the Software Center, select the package that matches your kernel. | virtualbox | virtualbox-current | | ---------------------------------------------------- | -------------------------------------------------------- | -| VirtualBox Host modules for the **linux-lts** kernel | VirtualBox Host modules for the **linux-current** kernel | +| VirtualBox host modules for the **linux-lts** kernel | VirtualBox host modules for the **linux-current** kernel | You **must** reboot your computer before running VirtualBox for the first time. -## Solus as Guest +## Solus as guest VirtualBox Guest Additions are available in the Software Center, select the package that matches kernel version on the Solus virtual machine. | virtualbox-guest | virtualbox-guest-common | | ----------------------------------------------------- | ------------------------------------------------------------ | -| VirtualBox Guest modules for the **linux-lts** kernel | Install this package if the **linux-current** kernel is used | +| VirtualBox guest modules for the **linux-lts** kernel | Install this package if the **linux-current** kernel is used | You **must** reboot your virtual machine to load the newly installed modules ## Extra configuration -#### USB Controller +#### USB controller If you want to use USB 2.0 or 3.0 in your virtual machine (and your hardware supports it), you have to install the [extension pack](https://www.virtualbox.org/manual/ch01.html#intro-installing). @@ -72,7 +72,7 @@ Note: Access to USB is granted by the user group `vboxusers` on the **Host** ope sudo gpasswd -a $USER vboxusers ``` -#### Shared Folders +#### Shared folders Share folders let you access files from the host system from within a guest machine. diff --git a/docs/user/software/web/obs.md b/docs/user/software/web/obs.md index 1f108c066..0bc073fe9 100644 --- a/docs/user/software/web/obs.md +++ b/docs/user/software/web/obs.md @@ -15,7 +15,7 @@ To install OBS Studio, either open up the Software Center and type `obs-studio` sudo eopkg install obs-studio ``` -## Virtual Camera +## Virtual camera OBS includes a virtual webcam device which can be used to send your OBS stream to video conferencing programs. In order to use this on Solus, you must first install from our repository a separate kernel module that is responsible for creating the necessary "loopback" device. There are two versions of this software available in the repository, you must choose the version that corresponds to the kernel you have installed. @@ -55,7 +55,7 @@ Additionally, the plugin may come with additional files or folders, such as loca Most Linux-supporting plugins should provide pre-compiled tarballs or zip files that you can extract to get a pre-made / ready folder structure that you can simply copy / paste into `~/.config/obs-studio/plugins` -### Known Working Plugins +### Known working plugins #### Input Overlay diff --git a/docs/user/troubleshooting/boot-rescue.md b/docs/user/troubleshooting/boot-rescue.md index bc244a488..ba42f4fcf 100644 --- a/docs/user/troubleshooting/boot-rescue.md +++ b/docs/user/troubleshooting/boot-rescue.md @@ -15,7 +15,7 @@ The inability to boot Solus can be attributed to various issues, such as: NOTE: Most examples below use sdX as the drive name. If your system has nvme drives, substitute the appropriate name, for example "nvme0n1". -## Multi-Booting +## Multi-booting Multi-booting is when you have multiple operating systems on the same device. Also referred to as "dual-booting" when only having two operating systems on the same device. @@ -29,7 +29,7 @@ If you get to an emergency prompt when the system tries to boot, check /etc/fsta UUID=XXXXXX /mnt/mydisk exfat noauto,uid=1000,gid=1000,umask=0022 0 0 ``` -## Incorrectly Applied Updates / Disk Changes +## Incorrectly applied updates / disk changes In the case that updates have not been applied correctly by the system, the updates were interrupted, or the disks have changed, it may be possible to boot rescue the Solus system. To do so, you will need: @@ -46,7 +46,7 @@ Whether you're using GRUB or UEFI, you will need to mount your Solus root (`/`) Note: If you see "lvm" as the type, the system has LVM partitions. See the next section for how to mount them. 4. If your root partition is of type sdX / nvme0n1x, replace the "sdX#" in the following command with the partition and mount to the target directory we created: `mount /dev/sdX# /target` -#### Encrypted Systems / LVM Systems +#### Encrypted systems / LVM systems If you use LVM volumes on your system, the process for mounting the system is a little different. If you use LUKS-based encryption, the process will involve decrypting your LUKS partition before mounting it to the correct location. To do this, note the sda / sdb device from the prior steps and follow the steps below: @@ -158,7 +158,7 @@ ln -s ../run/systemd/resolve/stub-resolv.conf /target/etc/resolv.conf 3. Chroot back into `/target` by running `chroot /target` again. 4. Retry networking. -### Repairing Packages +### Repairing packages In the event you had an incomplete upgrade, try the following commands: @@ -175,7 +175,7 @@ In the event that disk changes had caused the system to fail to boot, try the fo 1. Get the UUIDs of your partitions the system expects from `/etc/fstab`. 2. Compare this to the output of `ls -lah /dev/disk/by-uuid` -### Re-run System-Wide Configuration Triggers +### Re-run system-wide configuration triggers In the chroot environment, run the following command which will perform various configuration triggers to update your icon cache, update GRUB and EFI configuration, re-compile settings, and more. @@ -183,7 +183,7 @@ In the chroot environment, run the following command which will perform various sudo usysconf run -f ``` -### Regenerate UEFI Boot Entries +### Regenerate UEFI boot entries Run the following command, which will update the boot entries for your EFI menu: diff --git a/docs/user/troubleshooting/index.md b/docs/user/troubleshooting/index.md index 31f24a50d..758f8e83d 100644 --- a/docs/user/troubleshooting/index.md +++ b/docs/user/troubleshooting/index.md @@ -33,7 +33,7 @@ To run database recovery, run `sudo eopkg rdb` in the terminal and then updates ### Broken UI with Chromium applications -There is an [upstream bug](https://bugs.chromium.org/p/chromium/issues/detail?id=1442633) with Chromium that causes it to try to use an invalid shader cache instead of rebuilding it, crashing the GPU process. The issue is now fixed in Chromium, but it may take some time for applications to update their Chromium version. +There is an [upstream bug](https://issues.chromium.org/issues/40267041) with Chromium that causes it to try to use an invalid shader cache instead of rebuilding it, crashing the GPU process. The issue is now fixed in Chromium, but it may take some time for applications to update their Chromium version. To fix applications exhibiting this problem, run these commands to remove the shader cache: @@ -52,7 +52,7 @@ And restart the application. If booting into the previous kernel doesn't solve the issue, there may be an issue with the package updates. It is possible to [revert the updates](/docs/user/package-management/history-and-rollback) (this would also confirm that the issue is in the selected updates). -## Boot Failure +## Boot failure If Solus partially boots, you can generally get to a TTY using `Ctrl+Alt+F2` to login and be able to run commands just like using a terminal. This enables you to run some commands to identify or resolve the issue.