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
* 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
+++++++++
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
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.
::
- docs/
+ docs
├── guides
│ ├── onap-developer
│ │ ├── apiref
│ │ ├── 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
------------
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.
-