diff --git a/doc/source/common/git.rst b/doc/source/common/git.rst index 545dcb8..d3a4c43 100644 --- a/doc/source/common/git.rst +++ b/doc/source/common/git.rst @@ -48,13 +48,9 @@ For distributions like Debian, Ubuntu, or Mint open a terminal and type:: sudo apt install git -For distributions like RedHat, Fedora 21 or earlier, or CentOS open a terminal +For distributions like RedHat, Fedora or CentOS open a terminal and type:: - sudo yum install git - -For Fedora 22 or later open a terminal and type:: - sudo dnf install git For SUSE distributions open a terminal and type:: @@ -95,7 +91,7 @@ and email address. This is how your contributions will be identified:: Learning Git ------------ -You can use `Git Immersion `_ to work +You can use `Git Immersion `_ to work through tutorials for learning git. For reference, use the `Git Reference and Cheat Sheet `_. @@ -156,22 +152,22 @@ The following footer is required: StoryBoard specific footers: -- ``Task``: 1234: the number of the task in Storyboard implemented by the +- ``Task: 1234``: the number of the task in Storyboard implemented by the change. This will auto update the task to 'Review' status and assign it to you when you push the patch. -- ``Story``: 1234567: the number of the story in Storyboard to which the task +- ``Story: 1234567``: the number of the story in Storyboard to which the task being implemented belongs. This will post a comment on the story with a link to your patch. Launchpad specific footers: -- ``Closes-Bug``: #123456789: use ``Closes-Bug`` if the commit is intended to +- ``Closes-Bug: #123456789``: use ``Closes-Bug`` if the commit is intended to fully fix and close the bug being referenced. Use the Launchpad ID of the bug for the number; Gerrit automatically creates a link to the bug. -- ``Partial-Bug``: #123456789: use ``Partial-Bug`` if the commit is only a +- ``Partial-Bug: #123456789``: use ``Partial-Bug`` if the commit is only a partial fix and more work is needed. Use the Launchpad ID of the bug for the number; Gerrit automatically creates a link to the bug. -- ``Related-Bug``: #12456789: use 'Related-Bug' if the commit is merely +- ``Related-Bug: #12456789``: use ``Related-Bug`` if the commit is merely related to the referenced bug. Use the Launchpad ID of the bug for the number; Gerrit automatically creates a link to the bug. - ``Partial-Implements``: Use this footer if the change partially implements @@ -179,7 +175,6 @@ Launchpad specific footers: - ``Implements``: Use this footer if the change fully implements a Launchpad blueprint. Use the name of the blueprint as an ID. - The following footers are optional; however, their use is recommended if they are applicable to the patch: diff --git a/doc/source/common/setup-gerrit.rst b/doc/source/common/setup-gerrit.rst index c1640cb..de9e50a 100644 --- a/doc/source/common/setup-gerrit.rst +++ b/doc/source/common/setup-gerrit.rst @@ -98,10 +98,10 @@ to contribute. Contributors From the U.S. Government ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -#. Someone of authority needs to sign the `U.S. Government Contributor License - Agreement `_. Contact the - `Open Infrastructure Foundation `_ to - initiate this process. +Someone of authority needs to sign the `U.S. Government Contributor License +Agreement `_. Contact the +`Open Infrastructure Foundation `_ to +initiate this process. Setup SSH Keys ============== @@ -220,7 +220,7 @@ name above:: cat ~/.ssh/id_openstack_ed25519.pub -Highlight and copy the output. +Select and copy the output. Import Public Key Into Gerrit ----------------------------- @@ -281,13 +281,9 @@ For distributions like Debian, Ubuntu, or Mint open a terminal and type:: sudo apt install git-review -For distributions like RedHat, Fedora 21 or earlier, or CentOS open a terminal +For distributions like RedHat, Fedora or CentOS open a terminal and type:: - sudo yum install git-review - -For Fedora 22 or later open a terminal and type:: - sudo dnf install git-review For SUSE distributions open a terminal and type:: @@ -319,4 +315,4 @@ to enable pushing changes to Gerrit. .. note:: - Git reviews only needs to be initialized once in a repository. + Git review only needs to be initialized once in a repository.