[DOC-57 Add vnfrqts/guidelines submodule]

Change-Id: I483f12449de27a00421289438c73baa38e0fa1af
Signed-off-by: Rich Bennett <rb2745@att.com>

diff --git a/.gitmodules b/.gitmodules
new file mode 100644 (file)
index 0000000..90b5cb5
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "docs/submodules/vnfrqts/guidelines"]
+       path = docs/submodules/vnfrqts/guidelines
+       url = ../vnfrqts/guidelines

diff --git a/docs/conf.py b/docs/conf.py
index 580cce8..b3d7533 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -81,7 +81,10 @@ language = None
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = [
+       '_build',
+       'templates'
+       ]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.

diff --git a/docs/how-to-use-docs/addendum.rst b/docs/guide/onap-developer/how-to-use-docs/addendum.rst
similarity index 100%
rename from docs/how-to-use-docs/addendum.rst
rename to docs/guide/onap-developer/how-to-use-docs/addendum.rst

diff --git a/docs/how-to-use-docs/documentation-guide.rst b/docs/guide/onap-developer/how-to-use-docs/documentation-guide.rst
similarity index 92%
rename from docs/how-to-use-docs/documentation-guide.rst
rename to docs/guide/onap-developer/how-to-use-docs/documentation-guide.rst
index d519229..5dc3d71 100644 (file)
--- a/docs/how-to-use-docs/documentation-guide.rst
+++ b/docs/guide/onap-developer/how-to-use-docs/documentation-guide.rst
@@ -54,9 +54,11 @@ The documentation toolchain will look in these directories and be triggered by e
 containing these directories.
 when generating documents.
 
+.. index:: master, document
+
 Document Structure and Contribution
 -----------------------------------
-A top level structure is proposed for organizing and storing all documents.
+A top level master_document structure is proposed for organizing and storing all documents.
 Four areas as shown below with some additional detail under each area.
 This structure may change some as we get the full requirements and gain experience with the first reelase of ONAP.
 Where multiple sections with similar content are expected, templates can be created and stored 
@@ -70,16 +72,21 @@ consistency across projects.
 ::
 
         docs/
-        ├── onap-developer
-        │   ├── architecture
-        │   ├── develop
-        │   ├── test
-        │   └── tutorial
         ├── release
-        │   ├── configure
-        │   ├── install
         │   ├── overview
+        │   ├── architecture
+        │   ├── use-cases
+        │   ├── tutorials
         │   └── release-notes
+        ├── onap-developer
+        │   ├── design
+        │   ├── develop
+        │   ├── document
+        │   └── test
+        ├── administrator
+        │   ├── configure
+        │   ├── deploy
+        │   └── operate
         ├── service-designer
         │   ├── deploy
         │   ├── design

diff --git a/docs/how-to-use-docs/include-documentation.rst b/docs/guide/onap-developer/how-to-use-docs/include-documentation.rst
similarity index 100%
rename from docs/how-to-use-docs/include-documentation.rst
rename to docs/guide/onap-developer/how-to-use-docs/include-documentation.rst

diff --git a/docs/how-to-use-docs/index.rst b/docs/guide/onap-developer/how-to-use-docs/index.rst
similarity index 81%
rename from docs/how-to-use-docs/index.rst
rename to docs/guide/onap-developer/how-to-use-docs/index.rst
index df3b642..f2ec275 100644 (file)
--- a/docs/how-to-use-docs/index.rst
+++ b/docs/guide/onap-developer/how-to-use-docs/index.rst
@@ -1,7 +1,7 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 
-Documentation Guide
-===================
+Documentation
+=============
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/guide/onap-developer/index.rst b/docs/guide/onap-developer/index.rst
new file mode 100644 (file)
index 0000000..a6a5d22
--- /dev/null
+++ b/docs/guide/onap-developer/index.rst
@@ -0,0 +1,11 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+.. _onap_developer_guide:
+
+ONAP Developer Guide
+====================
+
+.. toctree::
+   :maxdepth: 1
+
+   how-to-use-docs/index

diff --git a/docs/guide/platform-administrator/index.rst b/docs/guide/platform-administrator/index.rst
new file mode 100644 (file)
index 0000000..7215c72
--- /dev/null
+++ b/docs/guide/platform-administrator/index.rst
@@ -0,0 +1,12 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+.. _service_designer_guide:
+
+Service Designer Guide
+======================
+
+.. toctree::
+   :maxdepth: 2
+
+More to be added
+----------------

diff --git a/docs/guide/service-designer/index.rst b/docs/guide/service-designer/index.rst
new file mode 100644 (file)
index 0000000..b872544
--- /dev/null
+++ b/docs/guide/service-designer/index.rst
@@ -0,0 +1,12 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+.. _administrator_guide:
+
+Admistrator Guide
+=================
+
+.. toctree::
+   :maxdepth: 2
+
+More to be added
+----------------

diff --git a/docs/guide/vnf-provider/index.rst b/docs/guide/vnf-provider/index.rst
new file mode 100644 (file)
index 0000000..cad3b7a
--- /dev/null
+++ b/docs/guide/vnf-provider/index.rst
@@ -0,0 +1,11 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+.. _vnf_provider_guide:
+
+VNF Provider Guide
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   ../../submodules/vnfrqts/guidelines/docs/index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 83f8b8a..ca298c1 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,15 +1,20 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 
-Welcome to ONAP documentation!
-================================
+.. _master_index:
 
-Contents:
+ONAP Documentation
+==================
 
 .. toctree::
    :maxdepth: 1
 
    release/index
-   how-to-use-docs/index
+   guide/onap-developer/index
+   guide/service-designer/index
+   guide/platform-administrator/index
+   guide/vnf-provider/index
+
+
 
 Indices and tables
 ==================
@@ -17,4 +22,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-

diff --git a/docs/release/index.rst b/docs/release/index.rst
index d73b25e..bfd896f 100644 (file)
--- a/docs/release/index.rst
+++ b/docs/release/index.rst
@@ -4,18 +4,29 @@
 Release
 =======
 
-Summary
-=======
-
 Overview of use cases, installation, release notes, etc.
 
 
+Architecture
+------------
+
+
+Use Cases
+---------
+
+
+Tutorials
+---------
+
+
 
+Release Notes
+-------------
 
 
-Contents:
+Component Specific Notes
+++++++++++++++++++++++++
 
 .. toctree::
    :maxdepth: 1
 
-   release-notes/index.rst

diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst
deleted file mode 100644 (file)
index 337469c..0000000
--- a/docs/release/release-notes/index.rst
+++ /dev/null
@@ -1,28 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-==============
-Release Notes
-==============
-
-Release notes as provided by the ONAP project documents are captured in this section.
-These include details of software versions used, known limitations and outstanding trouble
-reports.
-
-Summary
--------
-OpenECOMP 1.0.0 represents a complete demo platform with two
-service examples as contributed by AT&T to the Linux Foundation ONAP project.
-
-Installation Instructions
--------------------------
-
-BasicOpenECOMP installation instructions are available as a `README.md <https://nexus.openecomp.org/content/sites/raw/org.openecomp.demo/heat/1.0.0-SNAPSHOT/README.md>`_  file. Step by step tutorials for setting up a Rackspace account, using the portal, designing services, and instantiating services are provided here.
-
-
-Components
-----------
-
-.. toctree::
-   :maxdepth: 1
-
-

diff --git a/docs/submodules/vnfrqts/guidelines b/docs/submodules/vnfrqts/guidelines
new file mode 160000 (submodule)
index 0000000..0ac8f52
--- /dev/null
+++ b/docs/submodules/vnfrqts/guidelines
@@ -0,0 +1 @@
+Subproject commit 0ac8f52204d571ccd5a98af0e211bd138ceac846