From: Sofia Wallin Date: Tue, 6 Sep 2016 08:49:00 +0000 (+0200) Subject: Adjusted the docs structure according to directives X-Git-Tag: colorado.1.0 X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=refs%2Ftags%2Fcolorado.1.0;p=promise.git Adjusted the docs structure according to directives created subdirectory: docs/installationprocedure/images and copy both screenshots to this subdirectory. Updated according to comment Added a sub directory /installationprocedure and move the feature configuration to here Moved the abstract from the userguide/index.rst to the feature.userguide.rst Added a new index.rst in accordance to the new /installationprocedure Change-Id: Ie2acaddc1746fcee5baaca79713ea253c7d3f1b0 Signed-off-by: Sofia Wallin (cherry picked from commit d6e752f195525b396dad47ab339102120cd550e1) --- diff --git a/docs/userguide/feature.configguide.rst b/docs/installationprocedure/feature.configuration.rst similarity index 100% rename from docs/userguide/feature.configguide.rst rename to docs/installationprocedure/feature.configuration.rst diff --git a/docs/userguide/images/LICENSE b/docs/installationprocedure/images/LICENSE similarity index 100% rename from docs/userguide/images/LICENSE rename to docs/installationprocedure/images/LICENSE diff --git a/docs/userguide/images/screenshot_promise.png b/docs/installationprocedure/images/screenshot_promise.png similarity index 100% rename from docs/userguide/images/screenshot_promise.png rename to docs/installationprocedure/images/screenshot_promise.png diff --git a/docs/userguide/images/screenshot_promise_install.png b/docs/installationprocedure/images/screenshot_promise_install.png similarity index 100% rename from docs/userguide/images/screenshot_promise_install.png rename to docs/installationprocedure/images/screenshot_promise_install.png diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst new file mode 100644 index 0000000..41bc079 --- /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) + +************************************** +Promise installation and configuration +************************************** + +.. toctree:: + :numbered: + :maxdepth: 2 + + feature.configuration.rst diff --git a/docs/userguide/feature.userguide.rst b/docs/userguide/feature.userguide.rst index ac035f4..5fcae54 100644 --- a/docs/userguide/feature.userguide.rst +++ b/docs/userguide/feature.userguide.rst @@ -1,6 +1,13 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +Abstract +======== +This user guide document provides the users with: + +1. Short description of Promise project and key features implemented in +Colorado. + Promise description =================== Promise is a resource reservation and management project to identify NFV related diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index 696b341..f6cb21c 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -4,13 +4,9 @@ ================== Promise user guide ================== -This user guide document provides the users with: -1. Short description of Promise project and key features implemented in Colorado -2. Instructions to execute Promise test cases manually .. toctree:: :maxdepth: 3 feature.userguide.rst - feature.configguide.rst