Merge "Document temporary character of references in repolist.rst"
authorEric Debeau <eric.debeau@orange.com>
Fri, 12 Jul 2019 15:39:52 +0000 (15:39 +0000)
committerGerrit Code Review <gerrit@onap.org>
Fri, 12 Jul 2019 15:39:52 +0000 (15:39 +0000)
docs/guides/onap-developer/how-to-use-docs/include-documentation.rst

index d61cb9c..6f5b0d4 100644 (file)
@@ -51,7 +51,10 @@ login to gerrit or for git clone requests over ssh.
 The next step is to add a directory in the doc project where your
 project will be included as a submodule and at least one reference
 from the doc project to the documentation index in your repository.
-The following sequence will do this over ssh.
+The following sequence will do this over ssh. Please note that the
+reference to your project in *repolist.rst* should be considered
+temporary and removed when you reference it from more appropriate
+place.
 
 .. caution::