Add infra submodule

document how to add submodules
clean up some spacing

Change-Id: I7640f123911650dcf31933ed2fbfbdd26620798a
Signed-off-by: agardner <agardner@linuxfoundation.org>

diff --git a/.gitmodules b/.gitmodules
index dfb3093..efb29d5 100644 (file)
--- a/.gitmodules
+++ b/.gitmodules
@@ -34,10 +34,10 @@
        branch = .
        ignore = dirty
 [submodule "docs/submodules/dovetail"]
-        path = docs/submodules/dovetail
-        url = ../dovetail
-        branch = .
-        ignore = dirty
+       path = docs/submodules/dovetail
+       url = ../dovetail
+       branch = .
+       ignore = dirty
 [submodule "docs/submodules/escalator"]
        path = docs/submodules/escalator
        url = ../escalator
@@ -101,8 +101,8 @@
 [submodule "docs/submodules/openretriever"]
        path = docs/submodules/openretriever
        url = ../openretriever
-        branch = .
-        ignore = dirty
+       branch = .
+       ignore = dirty
 [submodule "docs/submodules/ovsnfv"]
        path = docs/submodules/ovsnfv
        url = ../ovsnfv
@@ -192,3 +192,8 @@
        url = ../barometer
        branch = .
        ignore = dirty
+[submodule "docs/submodules/infra"]
+       path = docs/submodules/infra
+       url = ../infra
+       branch = .
+       ignore = dirty

diff --git a/docs/how-to-use-docs/include-documentation.rst b/docs/how-to-use-docs/include-documentation.rst
index 1430b94..0bc3264 100644 (file)
--- 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

diff --git a/docs/submodules/infra b/docs/submodules/infra
new file mode 160000 (submodule)
index 0000000..1297f44
--- /dev/null
+++ b/docs/submodules/infra
@@ -0,0 +1 @@
+Subproject commit 1297f44c1bb0e9b0e2b9620b73190bec00604c24