aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSofia Wallin <sofia.wallin@ericsson.com>2016-08-31 16:58:13 +0200
committerBrady Johnson <brady.allen.johnson@ericsson.com>2016-09-01 08:40:15 +0000
commita0e2c1d0cbba861aac0b44bd61beb41ddca70630 (patch)
treedf2e9ae7e28afc2d90057c85af1ac49c24bf8d5f
parentecf444bb19bbfc538dffbadbe2d4701a8f67ff35 (diff)
Updated docs structure according to directives
Created a sub directory /installationprocedure and added a template for installation and configuration /feature.configuration.rst together with an index.rst Added a /feature.userguide.rst and index.rst under /userguide. Adjusted the releasenotes, renamed the index.rst to releasenotes.rst and added a separate index.rst. Change-Id: I95583558bee739ea1a62e3a4692e872b8025b1b8 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com> (cherry picked from commit d0bc418d7e4de5e1c2e4143570fa06fc60e1ac85)
-rw-r--r--docs/installationprocedure/feature.configuration.rst31
-rw-r--r--docs/installationprocedure/index.rst13
-rw-r--r--docs/releasenotes/index.rst13
-rw-r--r--docs/releasenotes/releasenotes.rst (renamed from docs/release-notes/index.rst)7
-rw-r--r--docs/userguide/feature.userguide.rst19
-rw-r--r--docs/userguide/index.rst13
6 files changed, 89 insertions, 7 deletions
diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst
new file mode 100644
index 0000000..a5ee416
--- /dev/null
+++ b/docs/installationprocedure/feature.configuration.rst
@@ -0,0 +1,31 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+<<<<<<< HEAD
+==========================
+Configuration of <feature>
+==========================
+=======
+=====================================================
+<scenario> installation and configuration instruction
+=====================================================
+>>>>>>> 78eabe91bc321a8668281f61d6b7930664e5bd8a
+
+Abstract
+========
+This document provides information on how to configure required
+components during the installation of the platform.
+
+Pre-configuration activites
+===========================
+List the information and activities needed as pre configuration.
+
+Feature configuration
+=====================
+<<<<<<< HEAD
+List the steps needed for the configuration of <feature>.
+=======
+List the steps needed for the configuration of <feature> and <components> of the scenario.
+
+>>>>>>> 78eabe91bc321a8668281f61d6b7930664e5bd8a
diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst
new file mode 100644
index 0000000..5327903
--- /dev/null
+++ b/docs/installationprocedure/index.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
+ .. (c) <optionally add copywriters name>
+
+**********************************************
+SFC installation and configuration instruction
+**********************************************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ feature.configuration.rst
diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst
new file mode 100644
index 0000000..e5e1dc6
--- /dev/null
+++ b/docs/releasenotes/index.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
+ .. (c) <optionally add copywriters name>
+
+*****************
+SFC Release Notes
+*****************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ releasenotes.rst
diff --git a/docs/release-notes/index.rst b/docs/releasenotes/releasenotes.rst
index 492db68..f239579 100644
--- a/docs/release-notes/index.rst
+++ b/docs/releasenotes/releasenotes.rst
@@ -1,10 +1,3 @@
-===========================================================
-OPNFV Release Note for the Brahmaputra release of OPNFV SFC
-===========================================================
-
-License
-=======
-
This work is licensed under a Creative Commons Attribution 4.0 International
License. .. http://creativecommons.org/licenses/by/4.0 ..
(c) Brady Johnson (Ericsson Inc.) and others
diff --git a/docs/userguide/feature.userguide.rst b/docs/userguide/feature.userguide.rst
new file mode 100644
index 0000000..b8adfa5
--- /dev/null
+++ b/docs/userguide/feature.userguide.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+<Feature> description
+=====================
+.. Describe the specific features and how it is realised in the scenario in a brief manner
+.. to ensure the user understand the context for the user guide instructions to follow.
+
+<Feature> capabilities and usage
+================================
+.. Describe the specific capabilities and usage for <XYZ> feature.
+.. Provide enough information that a user will be able to operate the feature on a deployed scenario.
+
+<Feature and API usage guidelines and example>
+-----------------------------------------------
+.. Describe with examples how to use specific features, provide API examples and details required to
+.. operate the feature on the platform.
+
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
new file mode 100644
index 0000000..9bfd243
--- /dev/null
+++ b/docs/userguide/index.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
+ .. (c) <optionally add copywriters name>
+
+**************
+SFC User Guide
+**************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ feature.userguide.rst