aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIdan Amit <ia096e@intl.att.com>2017-11-06 08:27:04 +0200
committerIdan Amit <ia096e@intl.att.com>2017-11-06 08:27:04 +0200
commita070cb63982f50d028889c97db8142a3cf88a42f (patch)
treebf0f4ce3646960c8f095d26dc2e1f7d426bbcd16
parent29df0797b7967382c5524ba0c963e2e15f608a5b (diff)
General arrangement for Read the Docs
Removed all the notes from the Read the Change-Id: I378a12a32df15ce05de1371cb187f31516009ee5 Issue-Id: SDC-626 Signed-off-by: Idan Amit <ia096e@intl.att.com>
-rw-r--r--docs/administration.rst18
-rw-r--r--docs/architecture.rst21
-rw-r--r--docs/delivery.rst11
-rw-r--r--docs/humaninterfaces.rst9
-rw-r--r--docs/installation.rst15
-rw-r--r--docs/sdcsdks.rst4
6 files changed, 2 insertions, 76 deletions
diff --git a/docs/administration.rst b/docs/administration.rst
index 91cfa3dd68..f05badd6e3 100644
--- a/docs/administration.rst
+++ b/docs/administration.rst
@@ -5,18 +5,6 @@
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.
-
-
Administration Links
====================
@@ -26,9 +14,3 @@ Here are some links to our administration pages found in the ONAP Services websi
- `SDC Jenkins <https://jenkins.onap.org/view/sdc/>`_
- `SDC Confluence Portal <https://wiki.onap.org/display/DW/Service+Design+and+Creation+%28SDC%29+Portal+WORK+IN+PROGRESS>`_
-Processes
----------
-
-
-Actions
--------
diff --git a/docs/architecture.rst b/docs/architecture.rst
index 232bbf0bd4..158849e28a 100644
--- a/docs/architecture.rst
+++ b/docs/architecture.rst
@@ -5,16 +5,6 @@
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.
-
SDC As Part of ONAP
===================
@@ -46,14 +36,3 @@ SDC uses two storage components: Elastic Search(ES) and Cassandra
- **Cassandra** is used to store auditing data, artifacts and data model objects.
-
-Capabilities
-============
-
-
-Usage Scenarios
-===============
-
-
-Interactions
-============
diff --git a/docs/delivery.rst b/docs/delivery.rst
index f337f08253..15070aab77 100644
--- a/docs/delivery.rst
+++ b/docs/delivery.rst
@@ -4,17 +4,6 @@
========
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.
-
SDC Dockers Containers Structure
================================
diff --git a/docs/humaninterfaces.rst b/docs/humaninterfaces.rst
index 44641e20f8..1182e704d2 100644
--- a/docs/humaninterfaces.rst
+++ b/docs/humaninterfaces.rst
@@ -5,15 +5,6 @@
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.
-
User Guides In ONAP Confluence
==============================
diff --git a/docs/installation.rst b/docs/installation.rst
index 0eeb60404e..840f2e4b9c 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -5,14 +5,6 @@
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.
-
Installation Guides
===================
@@ -21,10 +13,3 @@ Those are links to the SDC installation guides found in ONAP Confluence:
- `Deploying SDC on a Linux VM for Development <https://wiki.onap.org/display/DW/Deploying+SDC+on+a+Linux+VM+for+Development>`_
- `Using Vagrant-Onap for local deployment of SDC project <https://wiki.onap.org/pages/viewpage.action?pageId=15999821>`_
-
-Environment
-===========
-
-
-Steps
-=====
diff --git a/docs/sdcsdks.rst b/docs/sdcsdks.rst
index 4cb40e83b7..f428c3531f 100644
--- a/docs/sdcsdks.rst
+++ b/docs/sdcsdks.rst
@@ -16,8 +16,8 @@ The sdc projects consists of a few additional sub projects listed below:
- sdc-distribution-client
- sdc-titan-cassandra
-SDC SDKs guide
-==============
+SDC SDKs Explanations
+=====================
SDC-TOSCA and SDC-DISTRIBUTION-CLIENT
-------------------------------------