mirrors/ceph-csi
1
0
Fork 0
mirror of https://github.com/ceph/ceph-csi.git synced 2024-09-19 15:09:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: rename "master" branch to "devel"

Browse Source 
Signed-off-by: Niels de Vos <ndevos@redhat.com>
(cherry picked from commit 9f3d1b49b8)
This commit is contained in:
Niels de Vos 2021-02-25 09:19:23 +01:00 committed by Madhu Rajanna
parent 08599a537b
commit b8cb56d0d5
5 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/pull_request_template.md vendored
View File

@ -1,4 +1,4 @@
<!-- Please take a look at our [Contributing](https://github.com/ceph/ceph-csi/blob/master/docs/development-guide.md#Code-contribution-workflow) <!-- Please take a look at our [Contributing](https://github.com/ceph/ceph-csi/blob/devel/docs/development-guide.md#Code-contribution-workflow)
documentation before submitting a Pull Request! documentation before submitting a Pull Request!
Thank you for contributing to ceph-csi! --> Thank you for contributing to ceph-csi! -->

10
README.md
View File

@ -3,7 +3,7 @@
[![Go Report [![Go Report
Card](https://goreportcard.com/badge/github.com/ceph/ceph-csi)](https://goreportcard.com/report/github.com/ceph/ceph-csi) Card](https://goreportcard.com/badge/github.com/ceph/ceph-csi)](https://goreportcard.com/report/github.com/ceph/ceph-csi)
[![Build [![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) - [Ceph CSI](#ceph-csi)
- [Overview](#overview) - [Overview](#overview)
@ -33,9 +33,9 @@ attaching them to workloads.
Independent CSI plugins are provided to support RBD and CephFS backed volumes, Independent CSI plugins are provided to support RBD and CephFS backed volumes,
- For details about configuration and deployment of RBD plugin, please refer - 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 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/`. - For example usage of RBD and CephFS CSI plugins, see examples in `examples/`.
- Stale resource cleanup, please refer [cleanup doc](docs/resource-cleanup.md). - Stale resource cleanup, please refer [cleanup doc](docs/resource-cleanup.md).
@ -119,8 +119,8 @@ in the Kubernetes documentation.
## Contributing to this repo ## Contributing to this repo
Please follow [development-guide](<https://github.com/ceph/ceph-csi/tree/master/docs/development-guide.md>) Please follow [development-guide](<https://github.com/ceph/ceph-csi/tree/devel/docs/development-guide.md>)
and [coding style guidelines](<https://github.com/ceph/ceph-csi/tree/master/docs/coding.md>) and [coding style guidelines](<https://github.com/ceph/ceph-csi/tree/devel/docs/coding.md>)
if you are interested to contribute to this repo. if you are interested to contribute to this repo.
## Troubleshooting ## Troubleshooting

6
docs/ceph-csi-upgrade.md
View File

@ -83,11 +83,11 @@ to upgrade from cephcsi v3.0 to v3.1
## Upgrading from v3.1 to v3.2 ## 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 recommended that you use [official
releases](https://github.com/ceph/ceph-csi/releases) of Ceph-csi. Unreleased releases](https://github.com/ceph/ceph-csi/releases) of Ceph-csi. Unreleased
versions from the master branch are subject to changes and incompatibilities versions from the devel branch are subject to changes and incompatibilities
that will not be supported in the official releases. Builds from the master 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 branch can have functionality changed and even removed at any time without
compatibility support and without prior notice. compatibility support and without prior notice.

10
docs/development-guide.md
View File

@ -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*: work on a patch called *hellopatch*:
```console ```console
git checkout master git checkout devel
git pull git pull
git checkout -b hellopatch git checkout -b hellopatch
``` ```
@ -263,22 +263,22 @@ need to be met before it will be merged:
community feedback. community feedback.
* The 24 working hours counts hours occurring Mon-Fri in the local timezone * The 24 working hours counts hours occurring Mon-Fri in the local timezone
of the submitter. 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 * 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 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 on the PR. The bot will merge the PR if it's having one approval and the
label `ready-to-merge`. label `ready-to-merge`.
When the criteria are met, a project maintainer can merge your changes into 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 ### Backport a Fix to a Release Branch
The flow for getting a fix into a release branch is: 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. 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 PR with your commits backported to the release branch
1. If there are any conflicts you will need to resolve them by pulling the 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 branch, resolving the conflicts and force push back the branch

2
docs/snap-clone.md
View File

@ -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. have a PVC in bound state before creating snapshot from it.
It is recommended to create a volume snapshot or a PVC clone It is recommended to create a volume snapshot or a PVC clone
only when the PVC is not in use. 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. for more information on how to create a PVC.
- Verify if PVC is in Bound state - Verify if PVC is in Bound state