From 253858c104238cc48a0dd1ec6b488c89c7f75339 Mon Sep 17 00:00:00 2001 From: Niels de Vos Date: Thu, 25 Feb 2021 09:19:23 +0100 Subject: [PATCH] doc: rename "master" branch to "devel" Signed-off-by: Niels de Vos --- .github/pull_request_template.md | 2 +- README.md | 10 +++++----- docs/ceph-csi-upgrade.md | 6 +++--- docs/design/proposals/encryption-with-vault-tokens.md | 2 +- docs/development-guide.md | 10 +++++----- docs/snap-clone.md | 2 +- 6 files changed, 16 insertions(+), 16 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c9284acf4..0a76f23a5 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,4 +1,4 @@ - diff --git a/README.md b/README.md index e1edaeb7a..35f59b442 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/ceph/ceph-csi)](https://goreportcard.com/report/github.com/ceph/ceph-csi) [![Build -Status](https://travis-ci.org/ceph/ceph-csi.svg?branch=master)](https://travis-ci.org/ceph/ceph-csi) +Status](https://travis-ci.org/ceph/ceph-csi.svg?branch=devel)](https://travis-ci.org/ceph/ceph-csi) - [Ceph CSI](#ceph-csi) - [Overview](#overview) @@ -33,9 +33,9 @@ attaching them to workloads. Independent CSI plugins are provided to support RBD and CephFS backed volumes, - For details about configuration and deployment of RBD plugin, please refer - [rbd doc](https://github.com/ceph/ceph-csi/blob/master/docs/deploy-rbd.md) and + [rbd doc](https://github.com/ceph/ceph-csi/blob/devel/docs/deploy-rbd.md) and for CephFS plugin configuration and deployment please - refer [cephfs doc](https://github.com/ceph/ceph-csi/blob/master/docs/deploy-cephfs.md). + refer [cephfs doc](https://github.com/ceph/ceph-csi/blob/devel/docs/deploy-cephfs.md). - For example usage of RBD and CephFS CSI plugins, see examples in `examples/`. - Stale resource cleanup, please refer [cleanup doc](docs/resource-cleanup.md). @@ -118,8 +118,8 @@ in the Kubernetes documentation. ## Contributing to this repo -Please follow [development-guide]() -and [coding style guidelines]() +Please follow [development-guide]() +and [coding style guidelines]() if you are interested to contribute to this repo. ## Troubleshooting diff --git a/docs/ceph-csi-upgrade.md b/docs/ceph-csi-upgrade.md index 444d7cf13..ac36e35a6 100644 --- a/docs/ceph-csi-upgrade.md +++ b/docs/ceph-csi-upgrade.md @@ -83,11 +83,11 @@ to upgrade from cephcsi v3.0 to v3.1 ## Upgrading from v3.1 to v3.2 -**Ceph-csi releases from master are expressly unsupported.** It is strongly +**Ceph-csi releases from devel are expressly unsupported.** It is strongly recommended that you use [official releases](https://github.com/ceph/ceph-csi/releases) of Ceph-csi. Unreleased -versions from the master branch are subject to changes and incompatibilities -that will not be supported in the official releases. Builds from the master +versions from the devel branch are subject to changes and incompatibilities +that will not be supported in the official releases. Builds from the devel branch can have functionality changed and even removed at any time without compatibility support and without prior notice. diff --git a/docs/design/proposals/encryption-with-vault-tokens.md b/docs/design/proposals/encryption-with-vault-tokens.md index 906e05c9b..c8729a1e2 100644 --- a/docs/design/proposals/encryption-with-vault-tokens.md +++ b/docs/design/proposals/encryption-with-vault-tokens.md @@ -39,7 +39,7 @@ Encryption Key (DEK) for PVC encryption: - the KMS configuration is available for the Ceph-CSI pods at `/etc/ceph-csi-encryption-kms-config/config.json` - [example of the - configuration](https://github.com/ceph/ceph-csi/blob/master/examples/kms/vault/kms-config.yaml) + configuration](https://github.com/ceph/ceph-csi/blob/devel/examples/kms/vault/kms-config.yaml) ## Dependencies diff --git a/docs/development-guide.md b/docs/development-guide.md index 90e6e4111..8df6c8895 100644 --- a/docs/development-guide.md +++ b/docs/development-guide.md @@ -189,7 +189,7 @@ Here is a short guide on how to work on a new patch. In this example, we will work on a patch called *hellopatch*: ```console -git checkout master +git checkout devel git pull git checkout -b hellopatch ``` @@ -263,22 +263,22 @@ need to be met before it will be merged: community feedback. * The 24 working hours counts hours occurring Mon-Fri in the local timezone of the submitter. -* Each PR must be fully updated to master and tests must have passed +* Each PR must be fully updated to devel and tests must have passed * If the PR is having trivial changes or the reviewer is confident enough that PR doesn't need a second review, the reviewer can set `ready-to-merge` label on the PR. The bot will merge the PR if it's having one approval and the label `ready-to-merge`. When the criteria are met, a project maintainer can merge your changes into -the project's master branch. +the project's devel branch. ### Backport a Fix to a Release Branch The flow for getting a fix into a release branch is: -1. Open a PR to merge the changes to master following the process outlined above. +1. Open a PR to merge the changes to devel following the process outlined above. 1. Add the backport label to that PR such as `backport-to-release-vX.Y.Z` -1. After your PR is merged to master, the mergify bot will automatically open a +1. After your PR is merged to devel, the mergify bot will automatically open a PR with your commits backported to the release branch 1. If there are any conflicts you will need to resolve them by pulling the branch, resolving the conflicts and force push back the branch diff --git a/docs/snap-clone.md b/docs/snap-clone.md index 6f1b4e0b3..78acf5b78 100644 --- a/docs/snap-clone.md +++ b/docs/snap-clone.md @@ -60,7 +60,7 @@ The snapshot is created on/for an existing PVC. You should have a PVC in bound state before creating snapshot from it. It is recommended to create a volume snapshot or a PVC clone only when the PVC is not in use. -Please refer pvc creation [doc](https://github.com/ceph/ceph-csi/blob/master/docs/deploy-cephfs.md) +Please refer pvc creation [doc](https://github.com/ceph/ceph-csi/blob/devel/docs/deploy-cephfs.md) for more information on how to create a PVC. - Verify if PVC is in Bound state