summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer/how-to-use-docs
diff options
context:
space:
mode:
authorjsseidel <spence@research.att.com>2017-09-20 13:14:25 -0400
committerjsseidel <spence@research.att.com>2017-09-20 13:17:23 -0400
commitd06d57529116d9b1d9b3234672df2e22ff903fc9 (patch)
treef3793b2b0dc748b7d64aa789b17e1948222807a2 /docs/guides/onap-developer/how-to-use-docs
parent7783fee6e97448a7b0505a08176c99f1f4a814eb (diff)
Temporarily removing submodule workflow section
This section needs more work. There are a couple of subtle problems that we need to document regarding keeping the commit hash current to the doc superproject. I will be tracking thoughts in DOC-84. Change-Id: I854dc5bad7ccfacbf0e024f55aa5dfd40f1cbeed Issue-Id: DOC-84 Signed-off-by: jsseidel <spence@research.att.com>
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs')
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/index.rst1
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/update-review.rst8
2 files changed, 2 insertions, 7 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/index.rst b/docs/guides/onap-developer/how-to-use-docs/index.rst
index 941b15347..a73ae6fb3 100644
--- a/docs/guides/onap-developer/how-to-use-docs/index.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/index.rst
@@ -11,5 +11,4 @@ Creating Documentation
style-guide
include-documentation
converting-formats
- update-review
addendum
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 7a0cd39dc..eb4228da7 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
@@ -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,12 +92,6 @@ 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.