diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2018-11-09 18:46:18 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@opnfv.org> | 2018-11-09 18:46:18 +0000 |
| commit | 5e9c1775e3c52258f5a230358c18d5fbfa949401 (patch) | |
| tree | 659a84ba9183d45a782e049885fa8260dc3d9764 /docs/how-to-use-docs | |
| parent | c85a2be531eda41e3a634de67feb7ab49ac2397a (diff) | |
| parent | e096c7fb3fd1c43dbf6588ced287ece1db7d1350 (diff) | |
Merge "Fix minor Documentation Formatting Errors"
Diffstat (limited to 'docs/how-to-use-docs')
| -rw-r--r-- | docs/how-to-use-docs/documentation-guide.rst | 2 | ||||
| -rw-r--r-- | docs/how-to-use-docs/include-documentation.rst | 8 |
2 files changed, 7 insertions, 3 deletions
diff --git a/docs/how-to-use-docs/documentation-guide.rst b/docs/how-to-use-docs/documentation-guide.rst index 0f2c3bf02..9315a47b1 100644 --- a/docs/how-to-use-docs/documentation-guide.rst +++ b/docs/how-to-use-docs/documentation-guide.rst @@ -22,7 +22,7 @@ Read :ref:`this page <include-documentation>` which elaborates on how documentat 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: diff --git a/docs/how-to-use-docs/include-documentation.rst b/docs/how-to-use-docs/include-documentation.rst index d1a5a6227..1798469dc 100644 --- a/docs/how-to-use-docs/include-documentation.rst +++ b/docs/how-to-use-docs/include-documentation.rst @@ -1,4 +1,5 @@ .. _include-documentation: + ============================ Including your Documentation ============================ @@ -229,7 +230,7 @@ specified output folder directory. Adding your project repository as a submodule --------------------------- +--------------------------------------------- Clone the opnfvdocs repository and your submodule to .gitmodules following the convention of the file @@ -244,7 +245,10 @@ Clone the opnfvdocs repository and your submodule to .gitmodules following the c 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 |