diff options
| author |   Rich Bennett <rb2745@att.com> | 2017-08-15 07:56:32 -0400 |
|---|---|---|
| committer | Rich Bennett <rb2745@att.com> | 2017-08-16 01:14:19 +0000 |
| commit | 976bffd0713ada3d79158f985af7708d18da5a6a (patch) | |
| tree | 15191aac647715f8837fff5562749f2e6c98f397 /docs/guide/onap-developer/how-to-use-docs/addendum.rst | |
| parent | 8e2e21fa4a395afa8871a62261b456ea92be453c (diff) | |
Updates to How to Guide
Improve How to Use Documentation Guide including display
existing templates, consistency with the approved Jenkins
job templates, and other editorial improvements
Change-Id: I6a173a656acee2d675cb4af4c3070ab9ab9eb893
Issue-Id: DOC-59
Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/guide/onap-developer/how-to-use-docs/addendum.rst')
| -rw-r--r-- | docs/guide/onap-developer/how-to-use-docs/addendum.rst | 29 |
1 files changed, 16 insertions, 13 deletions
diff --git a/docs/guide/onap-developer/how-to-use-docs/addendum.rst b/docs/guide/onap-developer/how-to-use-docs/addendum.rst index ee0e5f24e..f97541730 100644 --- a/docs/guide/onap-developer/how-to-use-docs/addendum.rst +++ b/docs/guide/onap-developer/how-to-use-docs/addendum.rst @@ -4,7 +4,7 @@ Addendum ======== Index File -========== +---------- The index file must relatively reference your other rst files in that directory. @@ -23,7 +23,7 @@ Here is an example index.rst : documentation-example Source Files -============ +------------ Document source files have to be written in reStructuredText format (rst). Each file would be build as an html page. @@ -45,7 +45,7 @@ Here is an example source rst file : Hello! Writing RST Markdown -==================== +-------------------- See http://sphinx-doc.org/rest.html . @@ -59,22 +59,25 @@ You can add html content that only appears in html output by using the .. only:: html This line will be shown only in html version. +Jenkins Jobs +------------ + Verify Job ----------- +++++++++++ -The verify job name is **docs-verify-rtd-{branch}**. +The verify job name is **doc-{stream}-verify-rtd** -When you send document changes to gerrit, jenkins will create your documents -in HTML formats (normal and single-page) to verify that new document can be -built successfully. Please check the jenkins log and artifact carefully. -You can improve your document even if the build job succeeded. +Proposed changes in doc or any other repository that has been added as a +git submodule will be verified by this job prior to a gerrit code review. +Please check the Jenkins log carefully for warnings. +You can improve your document even if the verify job succeeded. Merge Job ----------- ++++++++++ -The merge job name is **docs-merge-rtd-{branch}**. +The merge job name is **doc-{stream}-merge-rtd**. -Once the patch is merged, jenkins will automatically trigger building of +When a committer merges a patch, Jenkins will automatically trigger building of the new documentation. This might take about 15 minutes while readthedocs -builds the documentatation. The newly built documentation shall show up +builds the documentation. The newly built documentation shall show up as appropriate placed in docs.onap.org/{branch}/path-to-file. |