From 25016837380a581df9259ebe5fb627244c7dfe79 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Tue, 30 Aug 2022 21:48:08 +1000 Subject: [PATCH] doc/start: update documenting-ceph branch names This PR updates the branch names in the documenting-ceph.rst file. It gets rid of all references to the "master" branch, and updates the language to reflect the state of play in 2022. inb4: This PR merely removes the most egregious inaccuracies, the ones that were most readily evident on a cursory perusal. The full text remains to be carefully read and fitted together with care. I had to start somewhere. Signed-off-by: Zac Dover (cherry picked from commit 7bc6262547c82dd6519e4099bfc4f082f14343ac) --- doc/start/documenting-ceph.rst | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/doc/start/documenting-ceph.rst b/doc/start/documenting-ceph.rst index 1ab3a87171d4..7df48d02c700 100644 --- a/doc/start/documenting-ceph.rst +++ b/doc/start/documenting-ceph.rst @@ -30,12 +30,14 @@ repository. Python Sphinx renders the source into HTML and manpages. Viewing Old Ceph Documentation ============================== -The https://docs.ceph.com link displays the ``master`` branch by default, but -you can view the documentation for older versions of Ceph (e.g., ``mimic``) by -replacing the version name in the url (e.g. ``pacific`` in -`https://docs.ceph.com/en/pacific `_) with the -branch name you prefer (e.g. ``mimic``, to create a URL that reads -`https://docs.ceph.com/en/mimic/ `_). +The https://docs.ceph.com link displays the latest release branch by default +(for example, if "Quincy" is the most recent release, then by default +https://docs.ceph.com displays the documentation for Quincy), but you can view +the documentation for older versions of Ceph (for example, ``pacific``) by +replacing the version name in the url (for example, ``quincy`` in +`https://docs.ceph.com/en/pacific `_) with the +branch name you prefer (for example, ``pacific``, to create a URL that reads +`https://docs.ceph.com/en/pacific/ `_). .. _making_contributions: @@ -140,13 +142,13 @@ Select a Branch --------------- When you make small changes to the documentation, such as fixing typographical -errors or clarifying explanations, use the ``master`` branch (default). You -should also use the ``master`` branch when making contributions to features that -are in the current release. ``master`` is the most commonly used branch. : +errors or clarifying explanations, use the ``main`` branch (default). You +should also use the ``main`` branch when making contributions to features that +are in the current release. ``main`` is the most commonly used branch. : .. prompt:: bash $ - git checkout master + git checkout main When you make changes to documentation that affect an upcoming release, use the ``next`` branch. ``next`` is the second most commonly used branch. : @@ -158,7 +160,7 @@ the ``next`` branch. ``next`` is the second most commonly used branch. : When you are making substantial contributions such as new features that are not yet in the current release; if your contribution is related to an issue with a tracker ID; or, if you want to see your documentation rendered on the Ceph.com -website before it gets merged into the ``master`` branch, you should create a +website before it gets merged into the ``main`` branch, you should create a branch. To distinguish branches that include only documentation updates, we prepend them with ``wip-doc`` by convention, following the form ``wip-doc-{your-branch-name}``. If the branch relates to an issue filed in -- 2.47.3