Skip to content

Document 'stable' branch and its relation to 'main' #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
felixfontein wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Document 'stable' branch and its relation to 'main' #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions content/en/docs/contribution-guidelines/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down