If this is your first encounter with a git-based workflow, we recommend that you study up on what git is and how git (and GitHub) works. One such tutorial is available here.
Before attempting to compile and show the website locally, please ensure that:
- NodeJS is installed on your system
pnpmis available and in your path- with NodeJS installed, you can run the following from your ${HOME} directory:
npm install pnpm@latest-11 - Make sure you add
${HOME}/node_modules/.binto your shell ${PATH}
- with NodeJS installed, you can run the following from your ${HOME} directory:
- With the above prerequisites satisfied, clone the present repo and cd into the root of it.
- Then run:
pnpm install
After the above import and install operations have completed successfully on your system, run:
pnpm run dev
... and follow the instructions shown.
At this point, any time you edit a page, the changes should show up live in your browser.
When you are happy with your edits, commit your changes in your local git repository and create a Pull Request from said local changes.
We recommend that you consult the Solus documentation style guide when it comes to how to address your target audience.
When describing your changes, use imperative mood, present tense and an active voice.
Example:
packaging: Add goober subsection on frobnicating
- Add up front context that the user needs to know
- Ensure that the structure flows naturally from start to finish
- Simplify the fiddlybob section language to shorter, international english sentences
- Run spellcheck on the changes to ensure they are written in US English.
This repository contains multiple types of content, each under its own licence:
| Content | Licence |
|---|---|
| Blog posts (src/content/docs/blog/) | CC BY-ND 4.0 |
| Documentation (src/content/docs/) | CC BY-SA 4.0 |
| Website code (Anything else) | MIT |
The website build configuration, templates, and code are licensed under the MIT licence.
Blog articles may be redistributed but not modified under the Creative Commons Attribution-NoDerivatives 4.0 International licence.
All documentation content may be shared and adapted under the terms of the Creative Commons Attribution-ShareAlike 4.0 International licence.
Some files might have a different license. See the file's content for details.
We recommend that you consult the Solus documentation style guide when it comes to how to address your target audience.
When describing your changes, use imperative mood, present tense and an active voice.
Example:
packaging: Add goober subsection on frobnicating
- Add up front context that the user needs to know
- Ensure that the structure flows naturally from start to finish
- Simplify the fiddlybob section language to shorter, international english sentences
- Run spellcheck on the changes to ensure they are written in US English.