Skip to content

Commit dd7c609

Browse files
committed
Add a little update to contributing
1 parent 79acdf3 commit dd7c609

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/CONTRIBUTING.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,15 @@
22

33
## Documenting the next release
44

5-
When you're contributing documentation changes for code in `master` branch, then documentation in `releases-source/` is where you should make changes. Changes made here will automatically be included in the next release.
5+
When you're contributing documentation changes for code in `main` branch, then documentation in `releases-source/` is where you should make changes. Changes made here will automatically be included in the next release.
66

77
## Improving documentation for existing releases
88

99
If you're contributing documentation for an existing release, then your documentation changes should go into the documentation for that release in `_releases/` folder, and possibly several of the following releases also.
1010

11+
### Where are all the _releases_?
12+
All the files that used to be under `_releases` in the `main` can be found in the `releases` branch. The `main` branch now only keeps the latest version. That means, to fix the docs of published releases you need to checkout the _relases branch_ and supply a PR against that.
13+
1114
## Running the documentation site locally
1215

1316
For casual improvements to the documentation, this shouldn't really be necessary, as all the content documents are plain markdown files.
@@ -30,6 +33,10 @@ bundle exec jekyll serve
3033

3134
After that you can access the site at http://localhost:4000/
3235

36+
Unfortunately, you will not see the full `release-source` without a little
37+
fiddling, as the site is excluded from Jekyll. So just supply a little symbolic
38+
link like this from the `./docs` dir: `mkdir releases && ln -s $PWD/release-source releases/latest`
39+
3340
## Linting of Markdown
3441

3542
To help keep the documentation syntactically consistent and free of syntax violations, a pre-commit hook using [markdownlint](https://github.com/DavidAnson/markdownlint) verifies Markdown documents.

0 commit comments

Comments
 (0)