Centralize readthedocs docs

Move readthedocs documentation into ccsdk/distribution so that there
is a single CCSDK project parent as opposed to separate repo-specific
parents.

Change-Id: I8f7fc649fd534dfc7e4a00f04728e0233ff4d23c
Issue-ID: CCSDK-140
Signed-off-by: Dan Timoney <dtimoney@att.com>

12 files changed, 246 insertions, 0 deletions

diff --git a/docs/sli/adaptors/architecture.rst b/docs/sli/adaptors/architecture.rst
new file mode 100644
index 00000000..8daa0d3b
--- /dev/null
+++ b/docs/sli/adaptors/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/sli/adaptors/build.rst b/docs/sli/adaptors/build.rst
new file mode 100644
index 00000000..0a4c308e
--- /dev/null
+++ b/docs/sli/adaptors/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/sli/adaptors/docs/architecture.rst b/docs/sli/adaptors/docs/architecture.rst
new file mode 100644
index 00000000..8daa0d3b
--- /dev/null
+++ b/docs/sli/adaptors/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/sli/adaptors/docs/build.rst b/docs/sli/adaptors/docs/build.rst
new file mode 100644
index 00000000..0a4c308e
--- /dev/null
+++ b/docs/sli/adaptors/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/sli/adaptors/docs/index.rst b/docs/sli/adaptors/docs/index.rst
new file mode 100644
index 00000000..3156c8ab
--- /dev/null
+++ b/docs/sli/adaptors/docs/index.rst
@@ -0,0 +1,12 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+CCSDK Service Logic Interpretor Adaptors
+----------------------------------------
+.. toctree::
+   :maxdepth: 1
+
+   architecture.rst
+   offeredapis.rst
+   logging.rst
+   build.rst
+   release-notes.rst
diff --git a/docs/sli/adaptors/docs/logging.rst b/docs/sli/adaptors/docs/logging.rst
new file mode 100644
index 00000000..187eb03b
--- /dev/null
+++ b/docs/sli/adaptors/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/sli/adaptors/docs/offeredapis.rst b/docs/sli/adaptors/docs/offeredapis.rst
new file mode 100644
index 00000000..e20c786c
--- /dev/null
+++ b/docs/sli/adaptors/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/sli/adaptors/docs/release-notes.rst b/docs/sli/adaptors/docs/release-notes.rst
new file mode 100644
index 00000000..b4516570
--- /dev/null
+++ b/docs/sli/adaptors/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
diff --git a/docs/sli/adaptors/index.rst b/docs/sli/adaptors/index.rst
new file mode 100644
index 00000000..3156c8ab
--- /dev/null
+++ b/docs/sli/adaptors/index.rst
@@ -0,0 +1,12 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+CCSDK Service Logic Interpretor Adaptors
+----------------------------------------
+.. toctree::
+   :maxdepth: 1
+
+   architecture.rst
+   offeredapis.rst
+   logging.rst
+   build.rst
+   release-notes.rst
diff --git a/docs/sli/adaptors/logging.rst b/docs/sli/adaptors/logging.rst
new file mode 100644
index 00000000..187eb03b
--- /dev/null
+++ b/docs/sli/adaptors/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/sli/adaptors/offeredapis.rst b/docs/sli/adaptors/offeredapis.rst
new file mode 100644
index 00000000..e20c786c
--- /dev/null
+++ b/docs/sli/adaptors/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/sli/adaptors/release-notes.rst b/docs/sli/adaptors/release-notes.rst
new file mode 100644
index 00000000..b4516570
--- /dev/null
+++ b/docs/sli/adaptors/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