Merge "Comment out broken intersphinx links"

[opnfvdocs.git] / docs / how-to-use-docs / documentation-guide.rst

diff --git a/docs/how-to-use-docs/documentation-guide.rst b/docs/how-to-use-docs/documentation-guide.rst
index fed42a4..9315a47 100644 (file)
--- a/docs/how-to-use-docs/documentation-guide.rst
+++ b/docs/how-to-use-docs/documentation-guide.rst
@@ -15,14 +15,14 @@ Getting Started with Documentation for Your Project
 OPNFV documentation is automated and integrated into our git & gerrit toolchains.
 
 We use RST document templates in our repositories and automatically render to HTML and PDF versions of the documents in our artifact
-store, our WiKi is also able to integrate these rendered documents directly allowing projects to use the revision controlled documentation
+store, our Wiki is also able to integrate these rendered documents directly allowing projects to use the revision controlled documentation
 process for project information, content and deliverables.
 Read :ref:`this page <include-documentation>` which elaborates on how documentation is to be included within opnfvdocs.
 
 Licencing your documentation
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 All contributions to the OPNFV project are done in accordance with the OPNFV licensing requirements. Documentation in OPNFV is contributed
-in accordance with the `Creative Commons 4.0 <https://creativecommons.org/licenses/by/4.0/>`_  and the `SPDX https://spdx.org/>`_ licence.
+in accordance with the `Creative Commons 4.0 <https://creativecommons.org/licenses/by/4.0/>`_  and the `SPDX <https://spdx.org/>`_ licence.
 All documentation files need to be licensed using the text below. The license may be applied in the first lines of
 all contributed RST files:
 
@@ -62,10 +62,14 @@ Following representation shows the expected structure:
         │   ├── scenarios
         │   │   └── scenario.name
         │   └── userguide
-        └── testing
-            ├── developer
-            └── user
-
+        ├── testing
+        │   ├── developer
+        │   └── user
+        └── infrastructure
+            ├── hardware-infrastructure
+            ├── software-infrastructure
+            ├── continuous-integration
+            └── cross-community-continuous-integration
 
 Release documentation
 ^^^^^^^^^^^^^^^^^^^^^
@@ -133,3 +137,8 @@ You are encouraged to establish the following basic structure for your project a
 **Project overview**: :code:`<repo>/docs/development/overview`
 
 - Folder for any project specific documentation.
+
+Infrastructure Documentation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Infrastructure documentation can be stored under :code:`<repo>/docs/` folder of
+corresponding infrastructure project.