The verify job name is **doc-{stream}-verify-rtd**
Proposed changes in files in any repository with the path
+
.. bash
- docs/**/*.rst
+
+ docs/**/*.rst
will be verified by this job prior to a gerrit code review.
Please check the Jenkins log carefully for warnings.
Setting Up
==========
+
Some initial set up is required to connect a project with
the master document structure and enable automated publishing of
changes as summarized in the following diagram and description below
The diagram below illustrates what is accomplished in the setup steps
above from the perspective of a file structure created for a local test,
a jenkins verify job, and/or published release documentation including:
- - ONAP gerrit project repositories,
+
+ - ONAP gerrit project repositories,
- doc project repository master document index.rst, templates, configuration, and other documents
- submodules directory where other project repositories and directories/files are referenced
- file structure: directories (ellipses), files(boxes)
Projects
--------
+
Documentation organized by the project delivering them.
+
.. note::
- When available these references should be changed to release artifacts
+ When available these references should be changed to release artifacts.
.. toctree::