Remove remaining warnings during Documentation buildings

[doc.git] / docs / guides / onap-developer / how-to-use-docs / introduction.rst

diff --git a/docs/guides/onap-developer/how-to-use-docs/introduction.rst b/docs/guides/onap-developer/how-to-use-docs/introduction.rst
index ef6ed95..250313f 100644 (file)
--- a/docs/guides/onap-developer/how-to-use-docs/introduction.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/introduction.rst
@@ -17,6 +17,20 @@ Much of the content in this document is derived from similar
 documentation processes used in other Linux Foundation
 Projects including OPNFV and Open Daylight.
 
+When is documentation required?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+All ONAP project contributions should have corresponding documentation.
+This includes all new features and changes to features that impact users.
+
+How do I create ONAP documentation?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ONAP documentation is written in ReStructuredText_ (an easy-to-read,
+what-you-see-is-what-you-get, plain text markup syntax).  The process for
+creating ONAP documentation and what documents are required are
+described in later sections of this Developer Documentation Guide.
+
+.. _ReStructuredText: http://docutils.sourceforge.net/rst.html
+
 Why reStructuredText/Sphinx?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -94,81 +108,77 @@ reference parts of source for documentation from other project
 repositories.  Other ONAP projects will provide content that
 is referenced from this structure.
 
-::
-
-docs
-├── guides
-│   ├── active-projects
-│   ├── onap-developer
-│   │   ├── apiref
-│   │   ├── architecture
-│   │   │   └── media
-│   │   ├── developing
-│   │   ├── how-to-use-docs
-│   │   ├── tutorials
-│   │   └── use-cases
-│   ├── onap-operator
-│   │   ├── cloud_site
-│   │   │   ├── aws
-│   │   │   ├── azure
-│   │   │   ├── k8s
-│   │   │   ├── openstack
-│   │   │   └── vmware
-│   │   ├── onap-portal-admin
-│   │   │   └── attachments
-│   │   └── settingup
-│   ├── onap-provider
-│   ├── onap-user
-│   │   ├── configure
-│   │   │   ├── change_config
-│   │   │   ├── pnf_connect
-│   │   │   └── vnf_connect
-│   │   ├── design
-│   │   │   ├── control-loop
-│   │   │   │   └── media
-│   │   │   ├── media
-│   │   │   ├── parameter_resolution
-│   │   │   │   └── ubuntu_example
-│   │   │   │       ├── cba-after-enrichment
-│   │   │   │       │   ├── Definitions
-│   │   │   │       │   ├── Templates
-│   │   │   │       │   └── TOSCA-Metadata
-│   │   │   │       ├── cba-before-enrichment
-│   │   │   │       │   ├── Definitions
-│   │   │   │       │   ├── Templates
-│   │   │   │       │   └── TOSCA-Metadata
-│   │   │   │       └── ubuntuCDS_heat
-│   │   │   ├── pre-onboarding
-│   │   │   │   └── media
-│   │   │   ├── resource-onboarding
-│   │   │   │   └── media
-│   │   │   ├── service-design
-│   │   │   │   └── media
-│   │   │   ├── service-distribution
-│   │   │   │   └── media
-│   │   │   └── vfcreation
-│   │   │       └── media
-│   │   ├── instantiate
-│   │   │   ├── instantiation
-│   │   │   │   ├── nbi
-│   │   │   │   ├── pnf_instance
-│   │   │   │   ├── service_instance
-│   │   │   │   ├── so1
-│   │   │   │   ├── so2
-│   │   │   │   ├── uui
-│   │   │   │   ├── vid
-│   │   │   │   ├── virtual_link_instance
-│   │   │   │   └── vnf_instance
-│   │   │   └── pre_instantiation
-│   │   └── onap-portal-user
-│   │       └── attachments
-│   └── overview
-│       └── media
-├── release
-├── templates
-│   ├── collections
-│   └── sections
-└── use-cases
+.. code-block::
+
+   docs
+   ├── guides
+   │   ├── onap-developer
+   │   │   ├── apiref
+   │   │   ├── architecture
+   │   │   │   └── media
+   │   │   ├── developing
+   │   │   └── how-to-use-docs
+   |   |   |   ├── templates
+   │   |   |   |   ├── collections
+   │   |   |   |   └── sections
+   │   ├── onap-operator
+   │   │   ├── cloud_site
+   │   │   │   ├── aws
+   │   │   │   ├── azure
+   │   │   │   ├── k8s
+   │   │   │   ├── openstack
+   │   │   │   └── vmware
+   │   │   ├── onap-portal-admin
+   │   │   │   └── attachments
+   │   │   └── settingup
+   │   ├── onap-provider
+   │   ├── onap-user
+   │   │   ├── configure
+   │   │   │   ├── change_config
+   │   │   │   ├── pnf_connect
+   │   │   │   └── vnf_connect
+   │   │   ├── design
+   │   │   │   ├── control-loop
+   │   │   │   │   └── media
+   │   │   │   ├── media
+   │   │   │   ├── parameter_resolution
+   │   │   │   │   └── ubuntu_example
+   │   │   │   │       ├── cba-after-enrichment
+   │   │   │   │       │   ├── Definitions
+   │   │   │   │       │   ├── Templates
+   │   │   │   │       │   └── TOSCA-Metadata
+   │   │   │   │       ├── cba-before-enrichment
+   │   │   │   │       │   ├── Definitions
+   │   │   │   │       │   ├── Templates
+   │   │   │   │       │   └── TOSCA-Metadata
+   │   │   │   │       └── ubuntuCDS_heat
+   │   │   │   ├── pre-onboarding
+   │   │   │   │   └── media
+   │   │   │   ├── resource-onboarding
+   │   │   │   │   └── media
+   │   │   │   ├── service-design
+   │   │   │   │   └── media
+   │   │   │   ├── service-distribution
+   │   │   │   │   └── media
+   │   │   │   └── vfcreation
+   │   │   │       └── media
+   │   │   ├── instantiate
+   │   │   │   ├── instantiation
+   │   │   │   │   ├── nbi
+   │   │   │   │   ├── pnf_instance
+   │   │   │   │   ├── service_instance
+   │   │   │   │   ├── so1
+   │   │   │   │   ├── so2
+   │   │   │   │   ├── uui
+   │   │   │   │   ├── vid
+   │   │   │   │   ├── virtual_link_instance
+   │   │   │   │   └── vnf_instance
+   │   │   │   └── pre_instantiation
+   │   │   └── onap-portal-user
+   │   │       └── attachments
+   │   └── overview
+   │       └── media
+   └── release
 
 
 Source Files