From faf2a5295a014d6dfb61a1df7bb0e1a370d14c00 Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Thu, 7 Jan 2021 14:16:00 -0800 Subject: [PATCH] Add branch guidance --- README.md | 14 ++++++++++++++ .../content/en/contributing/contributing-docs.md | 8 ++++++++ 2 files changed, 22 insertions(+) diff --git a/README.md b/README.md index 3845f7cfd..a8b5f5c4b 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,20 @@ If you are looking to explore the Dapr documentation, please go to the documenta This repo contains the markdown files which generate the above website. See below for guidance on running with a local environment to contribute to the docs. +## Branch guidance + +The Dapr docs handles branching differently than most code repositories. Instead of having a `master` or `main` branch, every branch is labeled to match the major and minor version of a runtime release. + +The following branches are currently maintained: + +| Branch | Website | Description | +|--------|---------|-------------| +| [v0.11](https://github.com/dapr/docs) (primary) | https://docs.dapr.io | Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here. +| [v1.0-rc2](https://github.com/dapr/docs/tree/v1.0-rc2) | https://v1-rc2.docs.dapr.io/ | Latest Dapr release candidate release documentation. Doc updates that are only applicable to v1.0-rc2+ go here. +| [v1.0-rc3](https://github.com/dapr/docs/tree/v1.0-rc3) (pre-release) | https://v1-rc3.docs.dapr.io/ | Pre-release release candidate documentation. Doc updates that are only applicable to v1.0-rc2+ go here. + +For more information visit the [Dapr branch structure](https://docs.dapr.io/contributing/contributing-docs/#branch-guidance) document. + ## Contribution guidelines Before making your first contribution, make sure to review the [contributing section](http://docs.dapr.io/contributing/) in the docs. diff --git a/daprdocs/content/en/contributing/contributing-docs.md b/daprdocs/content/en/contributing/contributing-docs.md index 179934fe6..39d6afc3e 100644 --- a/daprdocs/content/en/contributing/contributing-docs.md +++ b/daprdocs/content/en/contributing/contributing-docs.md @@ -18,6 +18,14 @@ Fork the [docs repository](https://github.com/dapr/docs) to work on any changes Follow the instructions in the repository [README.md](https://github.com/dapr/docs/blob/master/README.md#environment-setup) to install Hugo locally and build the docs website. +## Branch guidance + +The Dapr docs handles branching differently than most code repositories. Instead of having a `master` or `main` branch, every branch is labeled to match the major and minor version of a runtime release. For the full list visit the [Docs repo](https://github.com/dapr/docs#branch-guidance) + +Overall, all updates should go into the docs branch for the latest release of Dapr. You can find this directly at https://github.com/dapr/docs, as the latest release will be the default branch. For any docs changes that are applicable to a release candidate or a pre-release version of the docs, make your changes into that particular branch. + +For example, if you are fixing a typo, adding notes, or clarifying a point, make your changes into the default Dapr branch. If you are documenting an upcoming change to a component or the runtime, make your changes to the pre-release branch. Branches can be found in the [Docs repo](https://github.com/dapr/docs#branch-guidance) + ## Style and tone These conventions should be followed throughout all Dapr documentation to ensure a consistent experience across all docs.