Update ReadTheDocs docs folder

Change-Id: Ib1bf76d20f7e80a9152eb28c122cc5b98be0b1c8
Issue-ID: VID-71
Signed-off-by: Ofir Sonsino <os0695@att.com>

diff --git a/docs/docs-administration.rst b/docs/docs-administration.rst
new file mode 100644 (file)
index 0000000..94a7407
--- /dev/null
+++ b/docs/docs-administration.rst
@@ -0,0 +1,24 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Administration
+==============
+
+
+.. note::
+   * This section is used to describe a software component from the perspective of on-going
+     operation including regular processes and actions that are taken to configure and manage
+     the component. 
+   
+   * This section is typically: provided for platform-component or applications; and
+     referenced in user guides
+   
+   * This note must be removed after content has been added.
+
+
+Processes
+---------
+
+
+Actions
+-------

diff --git a/docs/intro/index.rst b/docs/docs-architecture.rst
similarity index 94%
rename from docs/intro/index.rst
rename to docs/docs-architecture.rst
index 6164ade..2710cb9 100644 (file)
--- a/docs/intro/index.rst
+++ b/docs/docs-architecture.rst
@@ -1,9 +1,9 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 
 
-VID Introduction
+VID Architecture
 =================
-Provides a well-structured organization of infrastructure deployment, 
+VID provides a well-structured organization of infrastructure deployment, 
 instantiation and change-management operations used by Operations to derive orchestrations and change-management.
 
 

diff --git a/docs/docs-configuration.rst b/docs/docs-configuration.rst
new file mode 100644 (file)
index 0000000..085f9c6
--- /dev/null
+++ b/docs/docs-configuration.rst
@@ -0,0 +1,27 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Configuration
+=============
+
+.. note::
+   * This section is used to describe the options a software component offers for configuration.
+
+   * Configuration is typically: provided for platform-component and sdk projects;
+     and referenced in developer and user guides.
+   
+   * This note must be removed after content has been added.
+
+
+
+Example ...
+
+You can provide the following in ``basic.conf``
+
+``host=ADDRESS``
+  The address of the host
+
+``port=PORT``
+  The port used for signaling
+
+  Optional. Default: ``8080``

diff --git a/docs/docs-consumedapis.rst b/docs/docs-consumedapis.rst
new file mode 100644 (file)
index 0000000..c2af4c2
--- /dev/null
+++ b/docs/docs-consumedapis.rst
@@ -0,0 +1,16 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Consumed APIs
+=============
+
+.. note::
+   * This section is used to reference APIs that a software component depends on
+     and uses from other sources.  
+   
+   * Consumed APIs should be a specific link to the offered APIs from another component
+     or external source.
+
+   * This note must be removed after content has been added.
+
+

diff --git a/docs/docs-delivery.rst b/docs/docs-delivery.rst
new file mode 100644 (file)
index 0000000..f3f083a
--- /dev/null
+++ b/docs/docs-delivery.rst
@@ -0,0 +1,44 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Delivery
+========
+
+.. note::
+   * This section is used to describe a software component packaging.
+     For a run-time component this might be executable images, containers, etc.
+     For an SDK this might be libraries.
+
+   * This section is typically provided for a platform-component and sdk;
+     and referenced in developer and user guides
+   
+   * This note must be removed after content has been added.
+
+Example use of a block diagram.
+
+.. blockdiag::
+   
+
+   blockdiag layers {
+   orientation = portrait
+   a -> m;
+   b -> n;
+   c -> x;
+   m -> y;
+   m -> z;
+   group l1 {
+       color = blue;
+       x; y; z;
+       }
+   group l2 {
+       color = yellow;
+       m; n; 
+       }
+   group l3 {
+       color = orange;
+       a; b; c;
+       }
+
+   }
+
+

diff --git a/docs/docs-humaninterfaces.rst b/docs/docs-humaninterfaces.rst
new file mode 100644 (file)
index 0000000..4292846
--- /dev/null
+++ b/docs/docs-humaninterfaces.rst
@@ -0,0 +1,17 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Human Interfaces
+================
+
+.. note::
+   * This section is used to describe a software component's command line and graphical
+     user interfaces.
+   
+   * This section is typically: provided for a platform-component and application; and
+     referenced from  user guides.
+   
+   * This note must be removed after content has been added.
+
+
+

diff --git a/docs/docs-installation.rst b/docs/docs-installation.rst
new file mode 100644 (file)
index 0000000..be64a63
--- /dev/null
+++ b/docs/docs-installation.rst
@@ -0,0 +1,20 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Installation
+============
+
+.. note::
+   * This section is used to describe how a software component is acquired and installed.
+   
+   * This section is typically: provided for a platform-component and application; and
+     referenced in user guides.
+
+   * This note must be removed after content has been added.
+
+Environment
+-----------
+
+
+Steps
+-----

diff --git a/docs/docs-logging.rst b/docs/docs-logging.rst
new file mode 100644 (file)
index 0000000..b65f2ae
--- /dev/null
+++ b/docs/docs-logging.rst
@@ -0,0 +1,36 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Logging
+=======
+
+.. note::
+   * This section is used to describe the informational or diagnostic messages emitted from 
+     a software component and the methods or collecting them.
+   
+   * This section is typically: provided for a platform-component and sdk; and
+     referenced in developer and user guides
+   
+   * This note must be removed after content has been added.
+
+
+Where to Access Information
+---------------------------
+
++------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
+| Location                                 | Type                | Description                                                                                                                                                                               | Rolling             |
++------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
+| /opt/app/vid/logs/vid/application.log    | Jetty server log    | This log describes inner flows inside VID                                                                                                                                                 | the log rolls daily |
++------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
+| /opt/app/vid/logs/vid/audit.log          | application audit   | An audit record is created for some of the operations in VID                                                                                                                              | rolls at 20 mb      |
++------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
+| /opt/app/vid/logs/vid/debug.log          | application logging | We can enable higher logging on demand by editing the logback.xml inside the server docker.                                                                                               | rolls at 20 mb      |
+|                                          |                     | The file is located under: WEB-INF/classes/logback.xml.                                                                                                                                   |                     |
+|                                          |                     | This log holds the debug and trace level output of the application.                                                                                                                       |                     |
++------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
+| /opt/app/vid/logs/vid/error.log          | application logging | This log holds the info and error level output of the application.                                                                                                                        | rolls at 20 mb      |
++------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
+
+
+Error / Warning Messages
+------------------------

diff --git a/docs/api/index.rst b/docs/docs-offeredapis.rst
similarity index 100%
rename from docs/api/index.rst
rename to docs/docs-offeredapis.rst

diff --git a/docs/docs-release-notes.rst b/docs/docs-release-notes.rst
new file mode 100644 (file)
index 0000000..b568bee
--- /dev/null
+++ b/docs/docs-release-notes.rst
@@ -0,0 +1,48 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Release Notes
+=============
+
+.. note::
+       * This Release Notes must be updated each time the team decides to Release new artifacts.
+       * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes.
+       * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes.
+       * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release.
+       * This note must be removed after content has been added.
+
+
+Version: x.y.z
+--------------
+
+
+:Release Date: yyyy-mm-dd
+
+
+
+**New Features**
+
+One or two sentences explaining the purpose of this Release.
+
+**Bug Fixes**
+       - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing.
+**Known Issues**
+       - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences.
+         One sentences explaining what is the issue.
+         
+         Another sentence explaining the impact of the issue.
+         
+         And an optional sentence providing a workaround.
+
+**Security Issues**
+       You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_
+
+
+**Upgrade Notes**
+
+**Deprecation Notes**
+
+**Other**
+
+===========
+
+End of Release Notes

diff --git a/docs/index.rst b/docs/index.rst
index 920bdb5..b971270 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,7 +1,18 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 
+VID Documentation
+=================
+
 .. toctree::
    :maxdepth: 2
-
-   intro/index
-   api/index
\ No newline at end of file
+   
+   administration.rst
+   architecture.rst
+   configuration.rst
+   consumedapis.rst
+   offeredapis.rst
+   delivery.rst
+   humaninterfaces.rst
+   installation.rst
+   logging.rst
+   release-notes.rst