diff options
| author |   Rich Bennett <rb2745@att.com> | 2018-11-27 09:36:32 -0500 |
|---|---|---|
| committer | Rich Bennett <rb2745@att.com> | 2018-11-27 09:45:33 -0500 |
| commit | 7fc6d943606fbc77d7d9719284bed78d9562ca3b (patch) | |
| tree | 783e229c46029cb6284edbc267463486d18bffb8 /docs/guides | |
| parent | 86df41e37d806ec9e0afc815b85f867de7fe71db (diff) | |
Add Pomba submodule
Add logging-analytics/pomba/pomba-audit-common as submodule
Updates to documentation guide
Issue-ID: DOC-323
Change-Id: Ied9363be20c39a893680b07bef964112361c9682
Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/guides')
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/addendum.rst | 3 | ||||
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst | 27 |
2 files changed, 10 insertions, 20 deletions
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 d51a41df3..ba35dcce1 100644 --- a/docs/guides/onap-developer/how-to-use-docs/addendum.rst +++ b/docs/guides/onap-developer/how-to-use-docs/addendum.rst @@ -130,9 +130,6 @@ will be verified by this job as part of a gerrit code review. * Using a browser to click on the *html* folder included in the log and preview how the proposed changes will look when published at Read The Docs. Small changes can be easily made in the patch set. - UML and Graphviz defined diagrams do not currently - render in the verify job log, but will render at Read The Docs - when the change is merged. Merge Job +++++++++ diff --git a/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst b/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst index 276c51cf1..ff4508090 100644 --- a/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst +++ b/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst @@ -10,8 +10,8 @@ content depending on the nature of the project. For example projects delivering a platform component may have different types of content than a project that creates libraries for a software development kit. The content from each project may be used together as a reference for -that project and/or be used in documents are tailored to a specific -user audience and task they are performing. +that project and/or be used in documents that are tailored to a specific +user audience and tasks they are performing. Much of the content in this document is derived from similar documentation processes used in other Linux Foundation @@ -25,7 +25,7 @@ with gerrit reviews, and published documents generated when there is a change in any source used to build the documentation. Authors create source for documents in reStructured Text (RST) that is -rendered to HTML and PDF and published on Readthedocs.io. +rendered to HTML and published on Readthedocs.io. The developer Wiki or other web sites can reference these rendered documents directly allowing projects to easily maintain current release documentation. @@ -109,7 +109,7 @@ is referenced from this structure. :: - docs/ + docs ├── guides │ ├── onap-developer │ │ ├── apiref @@ -117,20 +117,14 @@ is referenced from this structure. │ │ ├── developing │ │ ├── how-to-use-docs │ │ ├── settingup - │ │ └── tutorials + │ │ ├── tutorials + │ │ └── use-cases + │ ├── onap-provider │ └── onap-user - │ ├── onap-portal - │ ├── platform operations - │ ├── service design - │ ├── service deployment - │ ├── vnf provider - │ └── vnf certifier ├── release - ├── templates - │ ├── collections - │ └── sections - └── use-cases - + └── templates + ├── collections + └── sections Source Files ------------ @@ -159,4 +153,3 @@ files: When there are subsequent, significant contributions to a source file from a different contributor, a new copyright line may be appended after the last existing copyright line. - |