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
[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
url = ../barometer
branch = .
ignore = dirty
+[submodule "docs/submodules/infra"]
+ path = docs/submodules/infra
+ url = ../infra
+ branch = .
+ ignore = dirty
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