From: jsseidel <spence@research.att.com>
Date: Tue, 19 Sep 2017 20:51:26 +0000 (-0400)
Subject: Updated submodule section with new instructions
X-Git-Tag: 1.0.0-Amsterdam~2163^2
X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F95%2F13595%2F3;p=doc.git

Updated submodule section with new instructions

After trying the instructions in the submodule section,
I discovered there were a couple of steps missing, namely
replacing origin with gerrit and telling git-review what
the gerrit instances for the submodules are.

Change-Id: Ide084200ebcd84d838dabbf352466ec3ca032409
Issue-Id: DOC-84
Signed-off-by: jsseidel <spence@research.att.com>
---

diff --git a/docs/guides/onap-developer/how-to-use-docs/update-review.rst b/docs/guides/onap-developer/how-to-use-docs/update-review.rst
index 033f2f085..7a0cd39dc 100644
--- a/docs/guides/onap-developer/how-to-use-docs/update-review.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/update-review.rst
@@ -90,6 +90,26 @@ submodules. To pull in the latest changes:
 
    git submodule foreach 'git pull'
 
+Next, for every submodule, you'll need to rename 'origin' to 'gerrit':
+
+.. code:: bash
+
+   git submodule foreach 'git remote rename origin gerrit'
+
+Finally, for every submodule, you'll have to tell git-review how to find
+Gerrit. 
+
+.. code:: bash
+
+   cd doc # Make sure we're in the top level doc repo directory
+   git submodule foreach 'REPO=$(echo $path | sed "s/docs\/submodules\///") ; git remote add gerrit ssh://<LFID>@gerrit.onap.org:29418/$REPO'
+   
+Or, if you prefer to do only one at a time:
+
+.. code:: bash
+
+   git remote add gerrit ssh://<LFID>@gerrit.onap.org:29418/repopath/repo.git
+
 Requesting Reviews
 ------------------