Add warning for copying/replacing conf.py in Guide for Testing One Project

[doc.git] / docs / guides / onap-developer / how-to-use-docs / update-review.rst

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 033f2f0..eb4228d 100644 (file)
--- a/docs/guides/onap-developer/how-to-use-docs/update-review.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/update-review.rst
@@ -5,6 +5,8 @@
 Updates and Review
 ==================
 
+**NOTE: THIS SECTION IS UNDER HEAVY DEVELOPMENT USE WITH CAUTION**
+
 Most project owners will need only to concern themselves with their own
 project documentation. However, documentation team members and certain
 project owners will need to edit and test multiple documentation repositories.
@@ -90,6 +92,20 @@ submodules. To pull in the latest changes:
 
    git submodule foreach 'git pull'
 
+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
 ------------------