diff options
| author |   Sofia Wallin <sofia.wallin@est.tech> | 2020-09-09 10:49:38 +0200 |
|---|---|---|
| committer | Sofia Wallin <sofia.wallin@est.tech> | 2020-09-09 10:49:38 +0200 |
| commit | c9ac0f955cf72a189a0b2c10f003d3973d56a6fc (patch) | |
| tree | 6a56bf9fb1d75c47ba85171b431f1572691b2d1f /docs/how-to-use-docs/include-documentation.rst | |
| parent | 76ffa4a5013fd503a64fbcf013083355a0c9e5ef (diff) | |
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>
Diffstat (limited to 'docs/how-to-use-docs/include-documentation.rst')
| -rw-r--r-- | docs/how-to-use-docs/include-documentation.rst | 38 |
1 files changed, 0 insertions, 38 deletions
diff --git a/docs/how-to-use-docs/include-documentation.rst b/docs/how-to-use-docs/include-documentation.rst index 1798469dc..3920a0e18 100644 --- 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 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: @@ -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. - - -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 - |