diff options
| -rw-r--r-- | .gitmodules | 2 | ||||
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/addendum.rst | 4 | ||||
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/include-documentation.rst | 4 | ||||
| -rw-r--r-- | docs/release/repolist.rst | 4 |
4 files changed, 10 insertions, 4 deletions
diff --git a/.gitmodules b/.gitmodules index 7b8ef2350..756acae9a 100644 --- a/.gitmodules +++ b/.gitmodules @@ -40,6 +40,6 @@ ignore = dirty [submodule "docs/submodules/dcaegen2.git"] path = docs/submodules/dcaegen2.git - ../dcaegen2 + url = ../dcaegen2 branch = . ignore = dirty diff --git a/docs/guides/onap-developer/how-to-use-docs/addendum.rst b/docs/guides/onap-developer/how-to-use-docs/addendum.rst index 160b18fde..eccd0022a 100644 --- a/docs/guides/onap-developer/how-to-use-docs/addendum.rst +++ b/docs/guides/onap-developer/how-to-use-docs/addendum.rst @@ -115,8 +115,10 @@ Verify Job 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. diff --git a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst index 789ad7552..6ec4ed849 100644 --- a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst +++ b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst @@ -3,6 +3,7 @@ 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 @@ -130,7 +131,8 @@ to convert or add new content you can update the index and add files under the d 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) diff --git a/docs/release/repolist.rst b/docs/release/repolist.rst index 68ddf3373..831f3d2f0 100644 --- a/docs/release/repolist.rst +++ b/docs/release/repolist.rst @@ -2,9 +2,11 @@ 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:: |