summaryrefslogtreecommitdiffstats
path: root/docs/how-to-use-docs/include-documentation.rst
diff options
context:
space:
mode:
authoragardner <agardner@linuxfoundation.org>2017-04-27 13:27:05 +0200
committerAric Gardner <agardner@linuxfoundation.org>2017-05-08 22:18:54 +0000
commit8d3484686d216e48bac4ab6e9fb67bf8475568da (patch)
tree408b700926384470fadab679330e7f8ca6e09b2c /docs/how-to-use-docs/include-documentation.rst
parent18781cb0d42dab5f2b1faf01ff6148eaa8933bf7 (diff)
Add infra submodule
document how to add submodules clean up some spacing Change-Id: I7640f123911650dcf31933ed2fbfbdd26620798a Signed-off-by: agardner <agardner@linuxfoundation.org>
Diffstat (limited to 'docs/how-to-use-docs/include-documentation.rst')
-rw-r--r--docs/how-to-use-docs/include-documentation.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/how-to-use-docs/include-documentation.rst b/docs/how-to-use-docs/include-documentation.rst
index 1430b946d..0bc3264b6 100644
--- a/docs/how-to-use-docs/include-documentation.rst
+++ b/docs/how-to-use-docs/include-documentation.rst
@@ -226,3 +226,18 @@ 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 git https://gerrit.opnfv.org/gerrit/$reponame
+ git submodule init $reponame/
+ git submodule update $reponame/
+ git add .
+ git review