Create preliminary documentation

* Create documentation structure in docs folder
* Move api specification to openapi folder

Issue-ID: CPS-632
Signed-off-by: Bruno Sakoto <bruno.sakoto@bell.ca>
Change-Id: Iec2f703e0d3fe019f89f48dd135c4f96af65c330

diff --git a/docs/_static/css/ribbon.css b/docs/_static/css/ribbon.css
new file mode 100644 (file)
index 0000000..6008cb1
--- /dev/null
+++ b/docs/_static/css/ribbon.css
@@ -0,0 +1,63 @@
+.ribbon {
+  z-index: 1000;
+  background-color: #a00;
+  overflow: hidden;
+  white-space: nowrap;
+  position: fixed;
+  top: 25px;
+  right: -50px;
+  -webkit-transform: rotate(45deg);
+     -moz-transform: rotate(45deg);
+      -ms-transform: rotate(45deg);
+       -o-transform: rotate(45deg);
+          transform: rotate(45deg);
+  -webkit-box-shadow: 0 0 10px #888;
+     -moz-box-shadow: 0 0 10px #888;
+          box-shadow: 0 0 10px #888;
+
+}
+
+.ribbon a {
+  border: 1px solid #faa;
+  color: #fff;
+  display: block;
+  font: bold 81.25% 'Helvetica Neue', Helvetica, Arial, sans-serif;
+  margin: 1px 0;
+  padding: 10px 50px;
+  text-align: center;
+  text-decoration: none;
+  text-shadow: 0 0 5px #444;
+  transition: 0.5s;
+}
+
+.ribbon a:hover {
+  background: #c11;
+  color: #fff;
+}
+
+
+/* override table width restrictions */
+@media screen and (min-width: 767px) {
+
+   .wy-table-responsive table td, .wy-table-responsive table th {
+      /* !important prevents the common CSS stylesheets from overriding
+         this as on RTD they are loaded after this stylesheet */
+      white-space: normal !important;
+   }
+
+   .wy-table-responsive {
+      overflow: visible !important;
+   }
+}
+
+@media screen and (max-width: 767px) {
+    .wy-table-responsive table td {
+        white-space: nowrap;
+    }
+}
+
+/* fix width of the screen */
+
+.wy-nav-content {
+    max-width: none;
+}

diff --git a/docs/conf.py b/docs/conf.py
new file mode 100755 (executable)
index 0000000..189414d
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,34 @@
+# ============LICENSE_START=======================================================
+# Copyright (C) 2021 Bell Canada
+# ================================================================================
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# ============LICENSE_END=========================================================
+
+from docs_conf.conf import *
+
+branch = 'latest'
+doc_url = 'https://docs.onap.org/projects'
+master_doc = 'index'
+
+intersphinx_mapping = {}
+
+linkcheck_ignore = [
+    'http://localhost',
+]
+
+html_last_updated_fmt = '%d-%b-%y %H:%M'
+
+def setup(app):
+    app.add_css_file("css/ribbon.css")

diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644 (file)
index 0000000..8669911
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,24 @@
+# ============LICENSE_START=======================================================
+# Copyright (C) 2021 Bell Canada
+# ================================================================================
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# ============LICENSE_END=========================================================
+
+---
+project_cfg: onap
+project: onap
+
+# Change this to ReleaseBranchName to modify the header
+default-version: latest

diff --git a/docs/content/apis.rst b/docs/content/apis.rst
new file mode 100644 (file)
index 0000000..c483ea1
--- /dev/null
+++ b/docs/content/apis.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
+..
+.. Copyright (C) 2021 Bell Canada
+
+=========================
+CPS Temporal Exposed APIs
+=========================
+
+.. warning:: Draft
+
+* REST API
+
+  * Specification
+  * Postman Collection
+
+* Event Schema
+
+  * Json Schema

diff --git a/docs/content/architecture.rst b/docs/content/architecture.rst
new file mode 100644 (file)
index 0000000..18f4cc3
--- /dev/null
+++ b/docs/content/architecture.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+..
+.. Copyright (C) 2021 Bell Canada
+
+=========================
+CPS Temporal Architecture
+=========================
+
+.. warning:: Draft
+
+* Subsystem and components architecture

diff --git a/docs/content/deployment.rst b/docs/content/deployment.rst
new file mode 100644 (file)
index 0000000..4734b49
--- /dev/null
+++ b/docs/content/deployment.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
+..
+.. Copyright (C) 2021 Bell Canada
+
+=======================
+CPS Temporal Deployment
+=======================
+
+.. warning:: Draft
+
+* Deployment
+* Logging
+* Monitoring

diff --git a/docs/content/design.rst b/docs/content/design.rst
new file mode 100644 (file)
index 0000000..167d93d
--- /dev/null
+++ b/docs/content/design.rst
@@ -0,0 +1,11 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+..
+.. Copyright (C) 2021 Bell Canada
+
+===================
+CPS Temporal Design
+===================
+
+.. warning:: Draft

diff --git a/docs/content/modeling.rst b/docs/content/modeling.rst
new file mode 100644 (file)
index 0000000..b8bf91e
--- /dev/null
+++ b/docs/content/modeling.rst
@@ -0,0 +1,11 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+..
+.. Copyright (C) 2021 Bell Canada
+
+=====================
+CPS Temporal Modeling
+=====================
+
+.. warning:: Draft

diff --git a/docs/content/overview.rst b/docs/content/overview.rst
new file mode 100644 (file)
index 0000000..c4a981e
--- /dev/null
+++ b/docs/content/overview.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
+..
+.. Copyright (C) 2021 Bell Canada
+
+=====================
+CPS Temporal Overview
+=====================
+
+CPS Temporal is a service component belonging to CPS overall system.
+
+This service is responsible to provide a time oriented perspective for
+operational network data. It provides features to store and retrieve sequences
+of configurations or states along with the associated times when they occurred
+or have been observed.

diff --git a/docs/content/release-notes.rst b/docs/content/release-notes.rst
new file mode 100644 (file)
index 0000000..b7f680c
--- /dev/null
+++ b/docs/content/release-notes.rst
@@ -0,0 +1,38 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+..
+.. Copyright (C) 2021 Bell Canada
+
+==========================
+CPS Temporal Release Notes
+==========================
+
+This document contains information about CPS Temporal component releases.
+
+Following releases are available:
+
+* `1.0.0`_ (Istanbul)
+
+Istanbul Releases
+=================
+
+1.0.0
+-----
+
+.. warning:: Draft
+
+.. table::
+
+   =====================  =========================================
+   **Release Component**  CPS Temporal
+   **Release Name**       Istanbul 1.0.0
+   **Release Delivery**   Docker Image: ``onap/cps-temporal:1.0.0``
+   **Release Date**       *To be defined*
+   =====================  =========================================
+
+Added
+~~~~~
+
+* `CPS-369 <https://jira.onap.org/browse/CPS-369>`__ - Feature to store temporal data corresponding to CPS Core data node updates.
+* `CPS-370 <https://jira.onap.org/browse/CPS-370>`__ - Feature to query temporal data from REST API.

diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644 (file)
index 0000000..a491bfa
--- /dev/null
+++ b/docs/index.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
+..
+.. Copyright (C) 2021 Bell Canada
+
+============
+CPS Temporal
+============
+
+.. warning:: Draft
+
+.. toctree::
+   :maxdepth: 1
+
+   content/overview.rst
+   content/architecture.rst
+   content/design.rst
+   content/modeling.rst
+   content/deployment.rst
+   content/apis.rst
+   content/release-notes.rst

diff --git a/docs/tox.ini b/docs/tox.ini
new file mode 100644 (file)
index 0000000..78293e2
--- /dev/null
+++ b/docs/tox.ini
@@ -0,0 +1,39 @@
+# ============LICENSE_START=======================================================
+# Copyright (C) 2021 Bell Canada
+# ================================================================================
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# ============LICENSE_END=========================================================
+
+[tox]
+minversion = 1.6
+envlist = docs
+skipsdist = true
+
+[testenv:docs]
+basepython = python3
+deps = -r{toxinidir}/requirements-docs.txt
+commands =
+    sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
+    echo "Generated docs available in {toxinidir}/_build/html"
+whitelist_externals =
+    echo
+    git
+    sh
+
+[testenv:docs-linkcheck]
+basepython = python3
+commands = echo "Link Checking not enforced"
+whitelist_externals =
+    echo

diff --git a/docs/api/swagger/openapi.yml b/openapi/swagger/openapi.yml
similarity index 100%
rename from docs/api/swagger/openapi.yml
rename to openapi/swagger/openapi.yml

diff --git a/pom.xml b/pom.xml
index fa44f35..9415e06 100755 (executable)
--- a/pom.xml
+++ b/pom.xml
@@ -212,7 +212,7 @@
     <build>
         <resources>
             <resource>
-                <directory>docs/api</directory>
+                <directory>openapi</directory>
                 <targetPath>static</targetPath>
                 <filtering>true</filtering>
             </resource>
@@ -481,7 +481,7 @@
                             <goal>generate</goal>
                         </goals>
                         <configuration>
-                            <inputSpec>${project.basedir}/docs/api/swagger/openapi.yml</inputSpec>
+                            <inputSpec>${project.basedir}/openapi/swagger/openapi.yml</inputSpec>
                             <invokerPackage>org.onap.cps.temporal.controller.rest</invokerPackage>
                             <modelPackage>org.onap.cps.temporal.controller.rest.model</modelPackage>
                             <apiPackage>org.onap.cps.temporal.controller.rest</apiPackage>