This is the repository for Solus's Help Center documentation. This repository exists to help facilitate and encourage community contributions to improving our documentation and enabling an easier user experience for everyone.
Stumbled on this repo and have no idea what any of this is? Check out the Solus operating system!
git branch -m master old-help-center
git branch -m docusaurus master
git fetch origin
git branch -u origin/master master
git remote set-head origin -a
To get started developing our Docusaurus instance, or writing documentation, first fork this project in order to submit pull requests for your changes
This project is written using TypeScript and React, with some documentation being Markdown or MDX. To facilitate development, we use nvm and Yarn.
Please lint and spellcheck your updates before creating a pull request. We recommend VS Code with the "prettier" extension for linting. You are free to use whatever software and linters you prefer as long as they get the job done.
We recommend "Code Spell Checker" or codespell for spell checking.
Codespell is available for installation sudo eopkg install codespell
To set up nvm, the Node Version Manager, follow the instructions listed here. We recommend setting up their shell integration as well, so you can automatically switch to the correct Node version when working on this project. Otherwise, ensure you run nvm use. This project requires the "current" supported release series of Node.
You can validate you are using the latest by running node --version. Your version should be at least 19.x.
This project makes use of Yarn for its package management. After setting up nvm and ensuring you are running the latest Node, run:
corepack enable
To install the required dependencies, run: yarn
To start the live reloading Docusaurus, run: yarn start
- Clear local build cache:
yarn clear - Linting:
yarn lint - Updating translation files:
yarn write-translations - Validate build:
yarn build - Run validated build:
yarn serve
Publishing to https://help.getsol.us (via GH Pages)
Ensure that you can successfully generate a static site as above.
Then, when you're ready to deploy, run the following:
git switch deploy && git merge master
This obviously assumes that you have ssh push access to the help-center-docs repo and are using remote.origin.url=git@github.com:getsolus/help-center-docs.git (as listed by git config -l).
When updating an article, remember to update the date.
Note that multi-lingual documents are not yet supported on our Help Center. When it does, we'll be happy to accept non-English language documents.
Files relating to the parsing / build system are licensed under GPL-2.0. For the full text, view LICENSE.txt.
The Markdown files in this repository are licensed under the Creative Commons By-NC-SA 4.0 License. For the full text, view LICENSE-MD.txt. Solus Project is considered the sole rights holder of these works.
- Solus logo copyright and licensing information is provided on our Brand Guidelines page.
- Non-logo assets are licensed under Creative Commons By-NC-SA 4.0 License. For the full text, view LICENSE-MD.txt. Solus Project is considered the sole rights holder of these works.