From 6490cd976cc5393bdc62883bf37a626c2c4e615d Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Mon, 23 Feb 2026 06:34:39 +0100 Subject: [PATCH] Document 'stable' branch and its relation to 'main'. Signed-off-by: Felix Fontein --- content/en/docs/contribution-guidelines/_index.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/content/en/docs/contribution-guidelines/_index.md b/content/en/docs/contribution-guidelines/_index.md index 8f864f8..253b5dc 100644 --- a/content/en/docs/contribution-guidelines/_index.md +++ b/content/en/docs/contribution-guidelines/_index.md @@ -8,6 +8,18 @@ description: How to contribute to SOPS Check out [CONTRIBUTING.md in the getsops/sops GitHub repository](https://github.com/getsops/sops/blob/main/CONTRIBUTING.md). +## Documentation branching + +There are two main documentation branches: + +* `main`: This is the branch where most work happens on. + It should document the current state of [github.com/getsops/sops](https://github.com/getsops/sops)'s `main` branch. + This branch is published under [https://staging.getsops.io](https://staging.getsops.io). +* `stable`: This is the branch that is published at [getsops.io](https://getsops.io/). + The `main` branch is merged into it when a new SOPS release happens. + +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`). + ## Documentation contributions We use [Hugo](https://gohugo.io/) to format and generate our website, the