summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-documentation
diff options
context:
space:
mode:
authorthmsdt <thomas.kulik@telekom.de>2022-03-31 13:19:35 +0200
committerthmsdt <thomas.kulik@telekom.de>2022-03-31 13:21:35 +0200
commitc1d958ce2fd36dd8b452b9d5a1d1ff9bbfc1476b (patch)
treedd6518990c0438570ef4d87ce508253472de5106 /docs/guides/onap-documentation
parent90474b8d72afab8cc6e66fd2450019b29dcdb666 (diff)
update guide to create a doc development system (link collection, warning)
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I792476b9b9fa292f719f56ec551c6189bfcfbfd2
Diffstat (limited to 'docs/guides/onap-documentation')
-rw-r--r--docs/guides/onap-documentation/setup-of-a-doc-dev-system.rst13
1 files changed, 10 insertions, 3 deletions
diff --git a/docs/guides/onap-documentation/setup-of-a-doc-dev-system.rst b/docs/guides/onap-documentation/setup-of-a-doc-dev-system.rst
index 5d4fc59d6..6be2c6722 100644
--- a/docs/guides/onap-documentation/setup-of-a-doc-dev-system.rst
+++ b/docs/guides/onap-documentation/setup-of-a-doc-dev-system.rst
@@ -39,10 +39,10 @@ Setup of a Documentation Development System
#########################################################################
Release Relevance
- 10.0.0 (Jakarta) - 6.0.0 (Frankfurt)
+ 10.x.x (Jakarta) - 6.x.x (Frankfurt)
Last Review/Update
- 14/03/2022
+ 31/03/2022
Initial Release
05/12/2021
@@ -442,7 +442,7 @@ Please install ...
| GitLens | eamodio.gitlens | latest |
+--------------------------------------+---------------------------------------+---------+
-.. note:: Use the reStructuredText extension version 169.0.0 or lower to
+.. warning:: Use the reStructuredText extension version 169.0.0 or lower to
avoid problems with the preview. You need to downgrade after the initial
installation.
@@ -619,6 +619,7 @@ Documentation
-------------
- `Write The Docs: Documentation Guide <https://www.writethedocs.org/guide>`__
+- `Techwriter Documatt Blog <https://techwriter.documatt.com/>`__
Git
---
@@ -634,6 +635,12 @@ Python
- `Getting Started with Python in VS Code <https://code.visualstudio.com/docs/python/python-tutorial>`__
- `Linux Foundation Docs Conf <https://pypi.org/project/lfdocs-conf/>`__
+ReadTheDocs
+-----------
+
+- `Documentation <https://docs.readthedocs.io/en/stable/>`__
+- `GitHub <https://github.com/readthedocs/readthedocs.org/>`__
+
ReadTheDocs Sphinx Theme
------------------------