Submodule Transition ==================== Moving away from submodules. At the cost of some release-time overhead, there are several benefits the transition provides projects: * Local builds - Projects will be able to build and view there docs locally, as they would appear on the OPNFV Docs website. * Reduced build time - Patchset verification will only run against individual projects docs, not all projects. * Decoupled build failures - Any error introduced to project's docs would not break builds for all the other projects Steps ----- To make the transition the following steps need to be taken across three repositories: * Your project repository (Ex. Fuel) * The `Releng`_ repository * The `OPNFV Docs`_ repository .. _Releng: https://git.opnfv.org/releng/ .. _`OPNFV Docs`: https://git.opnfv.org/opnfvdocs/ In your project repo: #. Add the following files: *docs/conf.py* .. literalinclude:: files/conf.py *docs/conf.yaml* .. literalinclude:: files/conf.yaml *docs/requirements.txt* .. literalinclude:: files/requirements.txt *tox.ini* .. literalinclude:: files/tox.ini *.gitignore*:: .tox/ docs/_build/* *docs/index.rst* If this file doesn't exist, it will need to be created along any other missing index file for directories (release, development). Any example of the file's content looks like this: .. literalinclude:: files/index.rst In the releng repository: #. Update your project's job file **jjb//