Update: documentation guide

Removed old/outdated content
Added link to the LFN doc guide

Change-Id: Ifb0f2fa77f328ccf29c2df610e73b1999822f20f
Signed-off-by: Sofia Wallin <sofia.wallin@est.tech>

diff --git a/docs/how-to-use-docs/documentation-guide.rst b/docs/how-to-use-docs/documentation-guide.rst
index 9315a47..59a5425 100644 (file)
--- a/docs/how-to-use-docs/documentation-guide.rst
+++ b/docs/how-to-use-docs/documentation-guide.rst
@@ -15,14 +15,18 @@ 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
 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.
 process for project information, content and deliverables.

-Read :ref:`this page <include-documentation>` which elaborates on how documentation is to be included within opnfvdocs.
+The `LFN documenatation guide <https://docs.releng.linuxfoundation.org/en/latest/project-documentation.html>` explains how to enable
+your documenation build.

 
 Licencing your documentation
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 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.
+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.

 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:
 
 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:
 

diff --git a/docs/how-to-use-docs/include-documentation.rst b/docs/how-to-use-docs/include-documentation.rst
index 1798469..3920a0e 100644 (file)
--- a/docs/how-to-use-docs/include-documentation.rst
+++ b/docs/how-to-use-docs/include-documentation.rst
@@ -37,15 +37,6 @@ the documentation to the project repository.
 In OPNFVDocs Composite Documentation
 ------------------------------------
 
 In OPNFVDocs Composite Documentation
 ------------------------------------
 

-In toctree
-+++++++++++
-
-To import project documents from project repositories, we use submodules.
- Each project is stored in :code:`opnfvdocs/docs/submodule/` as follows:
-
-.. image:: Submodules.jpg
-   :scale: 50 %
-

 To include your project specific documentation in the composite documentation,
 first identify where your project documentation should be included.
 Say your project userguide should figure in the ‘OPNFV Userguide’, then:
 To include your project specific documentation in the composite documentation,
 first identify where your project documentation should be included.
 Say your project userguide should figure in the ‘OPNFV Userguide’, then:


@@ -227,32 +218,3 @@ Your documentation shall be built as HTML inside the
 specified output folder directory.
 
 .. note:: Be sure to remove the `conf.py`, the static/ files and the output folder from the `<project>/docs/`. This is for testing only. Only commit the rst files and related content.
 specified output folder directory.
 
 .. note:: Be sure to remove the `conf.py`, the static/ files and the output folder from the `<project>/docs/`. This is for testing only. Only commit the rst files and related content.

-
-
-Adding your project repository as a submodule
----------------------------------------------
-
-Clone the opnfvdocs repository and your submodule to .gitmodules following the convention of the file
-
-.. code-block:: bash
-
-  cd docs/submodules/
-  git submodule add https://gerrit.opnfv.org/gerrit/$reponame
-  git submodule init $reponame/
-  git submodule update $reponame/
-  git add .
-  git commit -sv
-  git review
-
-Removing a project repository as a submodule
---------------------------------------------
-
-.. code-block:: bash
-
-  git rm docs/submodules/$reponame
-  rm -rf .git/modules/$reponame
-  git config -f .git/config --remove-section submodule.$reponame 2> /dev/null
-  git add .
-  git commit -sv
-  git review
-