Skip to content

Commit bd33f54

Browse files
katshann-raspberrymudge
authored andcommitted
Add a little more about the new process to CONTRIBUTING file.
1 parent ad75bbb commit bd33f54

File tree

1 file changed

+23
-12
lines changed

1 file changed

+23
-12
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,45 @@
11
# Contributing to the Raspberry Pi Documentation
22

3-
The Raspberry Pi Documentation website is built from Asciidoc source using:
3+
Welcome to the [public repository](https://github.com/raspberrypi/documentation/) for the Raspberry Pi documentation. This repository contains the Asciidoc source and the Jekyll-based build tools for the HTML documentation hosted at the [Raspberry Pi documentation site](https://www.raspberrypi.com/documentation/).
44

5-
* [Asciidoctor](https://asciidoctor.org/)
6-
* [Jekyll](https://jekyllrb.com/)
7-
* [jekyll-asciidoc](https://github.com/asciidoctor/jekyll-asciidoc)
8-
* Python
5+
The public repository is a mirror of an internal repository from which the site is built. The master branch of this repository is automatically kept up to date with the latest published content on the [website](https://www.raspberrypi.com/documentation/).
96

10-
The website automatically deploys to [www.raspberrypi.com/documentation](https://www.raspberrypi.com/documentation) using GitHub Actions when new commits appear in the `master` branch.
7+
We encourage and value all types of contributions from our community. Please make sure to read the following section before making your contribution. It makes it a lot easier for the Raspberry Pi Technical Documentation team (the maintainers) and smooths out the experience for all involved. We look forward to your contributions.
118

129
## Contribute
1310

14-
To contribute or update documentation:
11+
To suggest changes to this documentation:
1512

16-
1. Create a fork of this repository on your GitHub account.
13+
1. Create a fork of the `raspberrypi/documentation` repository on your GitHub account.
1714

18-
1. Make changes in your fork. Start from the default `master` branch.
15+
1. Make changes in your fork. Start by branching from the default `master` branch.
1916

2017
1. Read our [style guide](https://github.com/raspberrypi/style-guide/blob/master/style-guide.md) to ensure that your changes are consistent with the rest of our documentation. Since Raspberry Pi is a British company, be sure to include all of your extra `u`s and transfigure those `z`s (pronounced 'zeds') into `s`s!
2118

2219
1. [Open a pull request](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) against this repository.
2320

24-
1. The maintainers will assess and copy-edit the PR. This can take anywhere from a few minutes to a few days, depending on the size of your PR, the time of year, and the availability of the maintainers.
21+
1. The maintainers assess the PR. We hope to get back to you within a fortnight, but this might vary depending on the size of your PR, the time of year, and the availability of the maintainers.
22+
23+
1. What happens next depends on the content of the PR and whether it inspires any wider changes:
2524

26-
1. After making any requested improvements to your PR, the maintainers will accept the PR and merge your changes into `master`, making them public on the production documentation site.
25+
* If we have questions about the PR, we work with you to understand what you are going for and how best the docs can achieve it.
26+
* If your PR can be included as-is, we use the patch mechanism to bring it across to the internal repository and commit it there. When the change is published on the Raspberry Pi Documentation website, it is mirrored to the public repository and your PR closes automatically.
27+
* If your PR needs significant editing or prompts a wider change to the documentation, we take on that work in our internal repository. We'll let you know if that's the case and how long we expect it to take.
28+
If we don't bring your initial changes over as a patch, we use the [co-author mechanism](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors) to ensure you get credit for your contribution.
2729

2830
Alternatively, [open an issue](https://github.com/raspberrypi/documentation/issues) to discuss proposed changes.
2931

3032
## Build
3133

34+
The Raspberry Pi Documentation website is built from Asciidoc source using:
35+
36+
* [Asciidoctor](https://asciidoctor.org/)
37+
* [Jekyll](https://jekyllrb.com/)
38+
* [jekyll-asciidoc](https://github.com/asciidoctor/jekyll-asciidoc)
39+
* Python
40+
41+
The website deploys to [www.raspberrypi.com/documentation](https://www.raspberrypi.com/documentation) from an internal repository that is mirrored to the [public repository](https://github.com/raspberrypi/documentation/).
42+
3243
### Install dependencies
3344

3445
To build the Raspberry Pi documentation locally, you'll need Ruby, Python, and the Ninja build system.
@@ -52,7 +63,7 @@ Close and re-launch your terminal window to use the new dependencies and configu
5263

5364
#### macOS
5465

55-
If you don't already have it, we recommend installing the [Homebrew](https://brew.sh/) package manager:
66+
If you don't already have it, we recommend installing the [Homebrew](https://brew.sh/) package manager:
5667

5768
```console
5869
$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

0 commit comments

Comments
 (0)