The Raspberry Pi Documentation website is built from Asciidoc source using Asciidoctor and a Jekyll and Python toolchain. The website is automatically deployed to the raspberrypi.com site — pushed to production — using GitHub Actions when a push to the master branch occurs.
Full instructions for building and running the documentation website locally can be found in the top-level README.md file.
In order to contribute new or updated documentation, you must first create a GitHub account and fork the original repository to your own account. You can make changes, save them in your forked repository, then make a pull request against this repository. The pull request will appear in the repository where it can be assessed by the maintainers, copy-edited, and if appropriate, merged with the official repository.
Unless you are opening a pull request which will only make small corrections, for instance, to correct a typo, you are more likely to get traction for your changes if you open an issue first to discuss the proposed changes. Issues and Pull Requests older than 60 days will automatically be marked as stale and then closed 7 days later if there still hasn't been any further activity.
NOTE: The default branch of the repository is the develop branch, and this should be the branch you get by default when you initially checkout the repository. You should target any pull requests against the develop branch, pull requests against the master branch will automatically fail checks and not be accepted.
NOTE: Issues and Pull Requests older than 60 days will automatically be marked as stale and then closed 7 days later if there still hasn't been any further activity.
Before starting to write your contribution to the documentation, you should take a look at the style guide.
IMPORTANT: Because the documentation makes use of the Asciidoc include statement, the xref: statements inside the documentation do not link back to the correct pages on Github, as Github does not support Asciidoc include functionality (see #2005). However, these links work correctly when the HTML documentation is built and deployed. Please do not submit Pull Requests fixing link destinations unless you're sure that the link is broken on the documentation site itself.
We welcome contributions from the community, ranging from correcting small typos all the way through to adding entirely new sections to the documentation. However, going forward we're going to be fairly targeted about what sorts of content we add to the documentation. We are looking to keep the repository, and the documentation, focused on Raspberry Pi-specific things, rather than having generic Linux or computing content.
We are therefore deprecating the more generic documentation around using the Linux operating system, ahead of removing these sections entirely at some point in the future as part of a larger update to the documentation site. This move is happening as we feel these sort of more general topics are, ten years on from when the documentation was initially written, now much better covered elsewhere on the web.
As such, we're not accepting PRs against these sections unless they're correcting errors.
NOTE: We are willing to consider toolchain-related contributions, but changes to the toolchain may have knock-on effects in other places, so it is possible that apparently benign pull requests that make toolchain changes could be refused for fairly opaque reasons.
In general, we will not accept content that is specific to an individual third-party service or product. We will also not embed, or add links, to YouTube videos showing tutorials on how to configure your Raspberry Pi.
The documentation is under a Creative Commons Attribution-Sharealike (CC BY-SA 4.0) licence. By contributing content to this repository, you are agreeing to place your contributions under this licence.