From 17f3bfdbbda16620a6ddc351a0030f51ceedb29c Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Thu, 30 Mar 2023 10:54:52 +1000 Subject: [PATCH] doc/start: format procedure in documenting-ceph Organize three steps in a procedure into one step with three sub-steps. Signed-off-by: Zac Dover (cherry picked from commit 6f3cd78f6116f3e19a8f6c5e0ebda816067a334e) --- doc/start/documenting-ceph.rst | 92 +++++++++++++++++----------------- 1 file changed, 47 insertions(+), 45 deletions(-) diff --git a/doc/start/documenting-ceph.rst b/doc/start/documenting-ceph.rst index ac5521d2294f5..3aff557b63b57 100644 --- a/doc/start/documenting-ceph.rst +++ b/doc/start/documenting-ceph.rst @@ -541,63 +541,65 @@ number of ways, but the example here will deal with a situation in which there are three commits and the changes in all three of the commits are kept. The three commits will be squashed into a single commit. -#. Make the first commit. +#. Make the commits that you will later squash. - :: - - doc/glossary: improve "CephX" entry - - Improve the glossary entry for "CephX". - - Signed-off-by: Zac Dover - - # Please enter the commit message for your changes. Lines starting - # with '#' will be ignored, and an empty message aborts the commit. - # - # On branch wip-doc-2023-03-28-glossary-cephx - # Changes to be committed: - # modified: glossary.rst - # - -#. Make the second commit. - - :: - - doc/glossary: add link to architecture doc - - Add a link to a section in the architecture document, which link - will be used in the process of improving the "CephX" glossary entry. - - Signed-off-by: Zac Dover + #. Make the first commit. + + :: + + doc/glossary: improve "CephX" entry + + Improve the glossary entry for "CephX". + + Signed-off-by: Zac Dover # Please enter the commit message for your changes. Lines starting # with '#' will be ignored, and an empty message aborts the commit. # # On branch wip-doc-2023-03-28-glossary-cephx - # Your branch is up to date with 'origin/wip-doc-2023-03-28-glossary-cephx'. - # # Changes to be committed: - # modified: architecture.rst + # modified: glossary.rst + # -#. Make the third commit. - - :: + #. Make the second commit. - doc/glossary: link to Arch doc in "CephX" glossary + :: + + doc/glossary: add link to architecture doc + + Add a link to a section in the architecture document, which link + will be used in the process of improving the "CephX" glossary entry. + + Signed-off-by: Zac Dover - Link to the Architecture document from the "CephX" entry in the - Glossary. + # Please enter the commit message for your changes. Lines starting + # with '#' will be ignored, and an empty message aborts the commit. + # + # On branch wip-doc-2023-03-28-glossary-cephx + # Your branch is up to date with 'origin/wip-doc-2023-03-28-glossary-cephx'. + # + # Changes to be committed: + # modified: architecture.rst - Signed-off-by: Zac Dover + #. Make the third commit. + + :: - # Please enter the commit message for your changes. Lines starting - # with '#' will be ignored, and an empty message aborts the commit. - # - # On branch wip-doc-2023-03-28-glossary-cephx - # Your branch is up to date with 'origin/wip-doc-2023-03-28-glossary-cephx'. - # - # Changes to be committed: - # modified: glossary.rst + doc/glossary: link to Arch doc in "CephX" glossary + + Link to the Architecture document from the "CephX" entry in the + Glossary. + + Signed-off-by: Zac Dover + + # Please enter the commit message for your changes. Lines starting + # with '#' will be ignored, and an empty message aborts the commit. + # + # On branch wip-doc-2023-03-28-glossary-cephx + # Your branch is up to date with 'origin/wip-doc-2023-03-28-glossary-cephx'. + # + # Changes to be committed: + # modified: glossary.rst #. There are now three commits in the feature branch. We will now begin the process of squashing them into a single commit. -- 2.39.5