From d4d9dc734e4c7d0685bac40f237c34fc1e489de3 Mon Sep 17 00:00:00 2001 From: Gergely Csatari Date: Fri, 2 Mar 2018 16:04:58 +0100 Subject: [PATCH] Adding a note to git setup to use consistent email addresses This change adds a note to use the same email adress in git config what was used during account setup. Also there are corrections to the indentations of notes all over the guide. Task: 6563 Change-Id: I96b7c248a3ceffd740e913e945eac57bb3db6801 Signed-off-by: Gergely Csatari --- doc/source/common/accounts.rst | 12 +++++------ doc/source/common/git.rst | 6 +++++- doc/source/common/setup-gerrit.rst | 32 +++++++++++++++--------------- 3 files changed, 27 insertions(+), 23 deletions(-) diff --git a/doc/source/common/accounts.rst b/doc/source/common/accounts.rst index 73ea731..c8edb01 100644 --- a/doc/source/common/accounts.rst +++ b/doc/source/common/accounts.rst @@ -17,8 +17,8 @@ Sign Up ------- .. note:: - Make sure to use the same email address you'll want to use for code - contributions since it's important later that these match up. + Make sure to use the same email address you'll want to use for code + contributions since it's important later that these match up. #. Go to the `OpenStack Foundation sign up page `_. @@ -35,10 +35,10 @@ Setup Your Bug Tracker Account ============================== .. note:: - The OpenStack community is currently in the process of moving from the bug - tracking software Launchpad to StoryBoard. Further in the project specific - on-boarding documentation, give special attention if the project is using - Launchpad or StoryBoard. + The OpenStack community is currently in the process of moving from the bug + tracking software Launchpad to StoryBoard. Further in the project specific + on-boarding documentation, give special attention if the project is using + Launchpad or StoryBoard. StoryBoard ---------- diff --git a/doc/source/common/git.rst b/doc/source/common/git.rst index 8a7fe76..618d6b7 100644 --- a/doc/source/common/git.rst +++ b/doc/source/common/git.rst @@ -4,7 +4,7 @@ Setup and Learn GIT .. note:: - This section assumes you have completed :doc:`accounts` guide. + This section assumes you have completed :doc:`accounts` guide. Git === @@ -79,6 +79,10 @@ and email address. This is how your contributions will be identified:: git config --global user.name "Firstname Lastname" git config --global user.email "your_email@youremail.com" +.. note:: + + Use the same email address that was used during the account setup. + Learning Git ============ diff --git a/doc/source/common/setup-gerrit.rst b/doc/source/common/setup-gerrit.rst index 2bc4496..baf560a 100644 --- a/doc/source/common/setup-gerrit.rst +++ b/doc/source/common/setup-gerrit.rst @@ -4,7 +4,7 @@ Setting Up Your Gerrit Account .. note:: - This section assumes you have completed :doc:`git` guide. + This section assumes you have completed :doc:`git` guide. What is Gerrit? =============== @@ -32,9 +32,9 @@ Sign Up .. note:: - From here on out when you sign into Gerrit, you'll be prompted to enter your - your Launchpad login info. This is because Gerrit uses it as an OpenID single - sign on. + From here on out when you sign into Gerrit, you'll be prompted to enter your + your Launchpad login info. This is because Gerrit uses it as an OpenID + single sign on. Individual Contributor License Agreement @@ -80,10 +80,10 @@ If you are contributing on behalf of a company or organization. .. note:: - Employers can update the list of authorized employees by filling out and - signing an `Updated Schedule - A Form - `_. + Employers can update the list of authorized employees by filling out and + signing an `Updated Schedule + A Form + `_. Contributors From the U.S. Government ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -206,18 +206,18 @@ pip. .. note:: - Mac OS X El Capitan and Mac OS Sierra users might see an error - message like "Operation not permitted" when installing with the command. - In this case, there are two options to successfully install git-review. + Mac OS X El Capitan and Mac OS Sierra users might see an error + message like "Operation not permitted" when installing with the command. + In this case, there are two options to successfully install git-review. - Option 1: install using pip with more options:: + Option 1: install using pip with more options:: - pip install --install-option '--install-data=/usr/local' git-review + pip install --install-option '--install-data=/usr/local' git-review - Option 2: Use the package manager `Homebrew `_, - and type in a terminal:: + Option 2: Use the package manager `Homebrew `_, + and type in a terminal:: - brew install git-review + brew install git-review Linux ^^^^^^