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>

diff --git a/.gitmodules b/.gitmodules
index 66de74e..8bed238 100644 (file)
--- a/.gitmodules
+++ b/.gitmodules
@@ -358,3 +358,8 @@
        url = ../policy/distribution
        branch = .
        ignore = dirty
        url = ../policy/distribution
        branch = .
        ignore = dirty

+[submodule "docs/submodules/logging-analytics/pomba/pomba-audit-common.git"]
+       path = docs/submodules/logging-analytics/pomba/pomba-audit-common.git
+       url = ../logging-analytics/pomba/pomba-audit-common
+       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 d51a41d..ba35dcc 100644 (file)
--- 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.
    * 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
 +++++++++
 
 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 276c51c..ff45080 100644 (file)
--- 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
 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
 
 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
 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.
 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
     ├── guides
     │   ├── onap-developer
     │   │   ├── apiref


@@ -117,20 +117,14 @@ is referenced from this structure.
     │   │   ├── developing
     │   │   ├── how-to-use-docs
     │   │   ├── settingup
     │   │   ├── developing
     │   │   ├── how-to-use-docs
     │   │   ├── settingup

-    │   │   └── tutorials
+    │   │   ├── tutorials
+    │   │   └── use-cases
+    │   ├── onap-provider

     │   └── onap-user
     │   └── onap-user

-    │       ├── onap-portal
-    │       ├── platform operations
-    │       ├── service design
-    │       ├── service deployment
-    │       ├── vnf provider
-    │       └── vnf certifier

     ├── release
     ├── release

-    ├── templates
-    │   ├── collections
-    │   └── sections
-    └── use-cases
-
+    └── templates
+        ├── collections
+        └── sections

 
 Source Files
 ------------
 
 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.
 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.

-

diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst
index 4b4586d..06094d9 100644 (file)
--- a/docs/release/releaserepos.rst
+++ b/docs/release/releaserepos.rst
@@ -128,6 +128,7 @@ Logging Analytics
    :titlesonly:
 
    logging-analytics<../submodules/logging-analytics.git/docs/release-notes.rst>
    :titlesonly:
 
    logging-analytics<../submodules/logging-analytics.git/docs/release-notes.rst>

+   pomba<../submodules/logging-analytics/pomba/pomba-audit-common.git/docs/release-notes.rst>

 
 Modeling
 --------
 
 Modeling
 --------

diff --git a/docs/submodules/logging-analytics/pomba/pomba-audit-common.git b/docs/submodules/logging-analytics/pomba/pomba-audit-common.git
new file mode 160000 (submodule)
index 0000000..28d58ce
--- /dev/null
+++ b/docs/submodules/logging-analytics/pomba/pomba-audit-common.git
@@ -0,0 +1 @@
+Subproject commit 28d58cedeba041e536d71f82325cb1d32eeba730