Skip to content

Commit 6490cd9

Browse files
committed
Document 'stable' branch and its relation to 'main'.
Signed-off-by: Felix Fontein <felix@fontein.de>
1 parent d35282e commit 6490cd9

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

  • content/en/docs/contribution-guidelines

content/en/docs/contribution-guidelines/_index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,18 @@ description: How to contribute to SOPS
88

99
Check out [CONTRIBUTING.md in the getsops/sops GitHub repository](https://github.com/getsops/sops/blob/main/CONTRIBUTING.md).
1010

11+
## Documentation branching
12+
13+
There are two main documentation branches:
14+
15+
* `main`: This is the branch where most work happens on.
16+
It should document the current state of [github.com/getsops/sops](https://github.com/getsops/sops)'s `main` branch.
17+
This branch is published under [https://staging.getsops.io](https://staging.getsops.io).
18+
* `stable`: This is the branch that is published at [getsops.io](https://getsops.io/).
19+
The `main` branch is merged into it when a new SOPS release happens.
20+
21+
Some work, like fixing typos, adjusting the design, etc., can happen directly on the `stable` branch (afterwards it needs to be merged back into `main`).
22+
1123
## Documentation contributions
1224

1325
We use [Hugo](https://gohugo.io/) to format and generate our website, the

0 commit comments

Comments
 (0)