summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rwxr-xr-x.gitignore1
-rw-r--r--docs/architecture.rst27
-rw-r--r--docs/build.rst23
-rw-r--r--docs/index.rst16
-rw-r--r--docs/logging.rst22
-rw-r--r--docs/offeredapis.rst16
-rw-r--r--docs/release-notes.rst46
7 files changed, 142 insertions, 9 deletions
diff --git a/.gitignore b/.gitignore
index 319e695b..a36bed32 100755
--- a/.gitignore
+++ b/.gitignore
@@ -17,6 +17,7 @@ workspace
target
target-ide
MANIFEST.MF
+**/yang-gen-sal
## Misc Ignores (OS specific etc) ##
bin/
diff --git a/docs/architecture.rst b/docs/architecture.rst
new file mode 100644
index 00000000..a1956d59
--- /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
index 00000000..99a061c2
--- /dev/null
+++ b/docs/build.rst
@@ -0,0 +1,23 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Build
+=====
+
+.. note::
+ * This section is used to describe how a software component is built from source
+ into something ready for use either in a run-time environment or to build other
+ components.
+
+ * This section is typically provided for a platform-component, application, and sdk; and
+ referenced in developer guides.
+
+ * This note must be removed after content has been added.
+
+
+Environment
+-----------
+
+
+Steps
+-----
diff --git a/docs/index.rst b/docs/index.rst
index 3a4849b2..2055f178 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,15 +1,13 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-SDNC Service Logic Interpreter
-------------------------------
+CCSDK Service Logic Interpreter
+-------------------------------
.. toctree::
:maxdepth: 1
-Offered APIs
-============
-List of Northbound APIs
+ architecture.rst
+ offeredapis.rst
+ logging.rst
+ build.rst
+ release-notes.rst
-SLI-API(2016-11-11)
-==================
-
-.. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=ccsdk/sli/core.git;a=blob_plain;f=sliapi/model/src/main/resources/ sli-api.20161110.json
diff --git a/docs/logging.rst b/docs/logging.rst
new file mode 100644
index 00000000..5662acb1
--- /dev/null
+++ b/docs/logging.rst
@@ -0,0 +1,22 @@
+.. 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
+---------------------------
+
+
+Error / Warning Messages
+------------------------
diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
new file mode 100644
index 00000000..de686ad3
--- /dev/null
+++ b/docs/offeredapis.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
+
+Offered APIs
+============
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+SLI-API(2016-11-11)
+===================
+
+.. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=ccsdk/sli/core.git;a=blob_plain;f=sliapi/model/src/main/resources/sli-api.20161110.json
+
+
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644
index 00000000..b4516570
--- /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