Add readthedocs for sdnc/oam

Add readthedocs sections for sdnc/oam.

Change-Id: I54b725947ef67b494388e919daccc08a7be7dc9b
Issue-ID: SDNC-72
Signed-off-by: Dan Timoney <dtimoney@att.com>

diff --git a/docs/architecture.rst b/docs/architecture.rst
new file mode 100644 (file)
index 0000000..8daa0d3
--- /dev/null
+++ b/docs/architecture.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
+
+Architecture
+============
+
+.. note::
+   * This section is used to describe a software component from a high level
+     view of capability, common usage scenarios, and interactions with other
+     components required in the usage scenarios.  
+   
+   * The architecture section is typically: provided in a platform-component
+     and sdk collections; and referenced from developer and user guides.
+   
+   * This note must be removed after content has been added.
+
+
+Capabilities
+------------
+
+
+Usage Scenarios
+---------------
+
+
+Interactions
+------------

diff --git a/docs/build.rst b/docs/build.rst
new file mode 100644 (file)
index 0000000..0a4c308
--- /dev/null
+++ b/docs/build.rst
@@ -0,0 +1,18 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Build
+=====
+
+
+Environment
+-----------
+Requires maven release 3.3 or greater
+
+Steps
+-----
+To compile this code:
+
+1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains references to the ONAP repositories and OpenDaylight repositories.
+
+2. To compile, run "mvn clean install".
\ No newline at end of file

diff --git a/docs/configuration.rst b/docs/configuration.rst
new file mode 100644 (file)
index 0000000..c6d382c
--- /dev/null
+++ b/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``
\ No newline at end of file

diff --git a/docs/consumedapis.rst b/docs/consumedapis.rst
new file mode 100644 (file)
index 0000000..fa72e02
--- /dev/null
+++ b/docs/consumedapis.rst
@@ -0,0 +1,15 @@
+.. 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/delivery.rst b/docs/delivery.rst
new file mode 100644 (file)
index 0000000..ba5d17b
--- /dev/null
+++ b/docs/delivery.rst
@@ -0,0 +1,43 @@
+.. 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/humaninterfaces.rst b/docs/humaninterfaces.rst
new file mode 100644 (file)
index 0000000..47afe69
--- /dev/null
+++ b/docs/humaninterfaces.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
+
+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/index.rst b/docs/index.rst
index 833e1aa..13ffbf8 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,8 +1,20 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+SDNC Northbound
+===============
 
-TODO Add files to toctree and delete this header
-------------------------------------------------
 .. toctree::
    :maxdepth: 1
 
-
+   architecture.rst
+   offeredapis.rst
+   consumedapis.rst
+   delivery.rst
+   logging.rst
+   installation.rst
+   configuration.rst
+   administration.rst
+   humaninterfaces.rst
+   release-notes.rst

diff --git a/docs/installation.rst b/docs/installation.rst
new file mode 100644 (file)
index 0000000..d7c4e07
--- /dev/null
+++ b/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/logging.rst b/docs/logging.rst
new file mode 100644 (file)
index 0000000..187eb03
--- /dev/null
+++ b/docs/logging.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Logging
+=======
+CCSDK uses slf4j to log messages to the standard OpenDaylight karaf.log
+log file.
+
+Where to Access Information
+---------------------------
+Logs are found within the SDNC docker container, in the directory
+/opt/opendaylight/current/data/logs.
+
+

diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
new file mode 100644 (file)
index 0000000..e20c786
--- /dev/null
+++ b/docs/offeredapis.rst
@@ -0,0 +1,6 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Offered APIs
+============
+

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644 (file)
index 0000000..b451657
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,46 @@
+.. 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**
+
+===========
\ No newline at end of file