summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer/how-to-use-docs/introduction.rst
diff options
context:
space:
mode:
authorAndrea Visnyei <andrea.visnyei@nokia.com>2021-04-23 12:42:55 +0200
committerAndrea Visnyei <andrea.visnyei@nokia.com>2021-04-30 12:29:45 +0200
commitc633c6f4706ab9ca1830c146a32592628287ce22 (patch)
treed30f1affdffb9f7a3b649536a572ae5bae392f85 /docs/guides/onap-developer/how-to-use-docs/introduction.rst
parent4779e9af8d5a5a990bdb5683f71b7ca558a0b09e (diff)
Move examples from Addendum to Setting Up chapter
Moved RST file examples and Jenkins info to Setting up chapter and RTD URLs to Introduction. Issue-ID: DOC-719 Change-Id: I3e8ac614985858f2e3999a325e7575d66c8a7f84 Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs/introduction.rst')
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/introduction.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/introduction.rst b/docs/guides/onap-developer/how-to-use-docs/introduction.rst
index 250313fc4..242a2d239 100644
--- a/docs/guides/onap-developer/how-to-use-docs/introduction.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/introduction.rst
@@ -208,3 +208,19 @@ files:
When there are subsequent, significant contributions to a source file
from a different contributor, a new copyright line may be appended
after the last existing copyright line.
+
+Read The Docs URLs
+------------------
+
+When referencing versions of documentation a Read The Docs the following
+URL conventions should be used
+
+ +----------------------------------+----------------------------------------+
+ | URL | To Refer to |
+ +==================================+========================================+
+ | docs.onap.org | Most recent approved named release |
+ +----------------------------------+----------------------------------------+
+ | docs.onap.org/en/latest | Latest master branch all projects |
+ +----------------------------------+----------------------------------------+
+ | docs.onap.org/en/*named release* | An approved name release eg. amsterdam |
+ +----------------------------------+----------------------------------------+