summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKrzysztof Opasiak <k.opasiak@samsung.com>2019-07-09 23:31:00 +0200
committerKrzysztof Opasiak <k.opasiak@samsung.com>2019-07-09 23:31:00 +0200
commit6688fd00ba150d6bd5c4e2f6cb91dd0c88fbf371 (patch)
treedb166cfbcdd895806bd223bc181761be2d93ed0c /docs
parentcd75e10a1bebebb014f8fe2fe12ad50a89637d34 (diff)
Document temporary character of references in repolist.rst
According to the comment in repolist.rst references there are only temporary and should be removed when the project is referenced from more appropriate place. Unfortunately developer may never notice this comment as writting to this file in documentation is done by echo command. To improve this situation let's add an explicit mention about this temporary character of repolist.rst to the documentation. Issue-ID: DOC-501 Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com> Change-Id: I8d8b5fe03d29b5141d57e1d06220bd6382a52861
Diffstat (limited to 'docs')
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/include-documentation.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst
index 6909cceb1..996d44e36 100644
--- a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst
@@ -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::