From: Gerald Kunzmann Date: Thu, 9 Feb 2017 09:36:29 +0000 (+0000) Subject: Update docs structure according to new guidelines in https://wiki.opnfv.org/display/DOC X-Git-Tag: danube.1.RC1~6^2 X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=78aa63af02df682b3c8d825c1bec9cec6cd3b207;p=promise.git Update docs structure according to new guidelines in https://wiki.opnfv.org/display/DOC Change-Id: I69e6536d9044dd9db2ed3cd698059aa3a800c318 Signed-off-by: Gerald Kunzmann --- diff --git a/docs/requirements/NB_interface.rst b/docs/development/requirements/NB_interface.rst similarity index 100% rename from docs/requirements/NB_interface.rst rename to docs/development/requirements/NB_interface.rst diff --git a/docs/requirements/annex1.rst b/docs/development/requirements/annex1.rst similarity index 100% rename from docs/requirements/annex1.rst rename to docs/development/requirements/annex1.rst diff --git a/docs/requirements/architecture.rst b/docs/development/requirements/architecture.rst similarity index 100% rename from docs/requirements/architecture.rst rename to docs/development/requirements/architecture.rst diff --git a/docs/requirements/gap_analysis.rst b/docs/development/requirements/gap_analysis.rst similarity index 100% rename from docs/requirements/gap_analysis.rst rename to docs/development/requirements/gap_analysis.rst diff --git a/docs/requirements/glossary.rst b/docs/development/requirements/glossary.rst similarity index 100% rename from docs/requirements/glossary.rst rename to docs/development/requirements/glossary.rst diff --git a/docs/requirements/images/LICENSE b/docs/development/requirements/images/LICENSE similarity index 100% rename from docs/requirements/images/LICENSE rename to docs/development/requirements/images/LICENSE diff --git a/docs/requirements/images/computeflavor.png b/docs/development/requirements/images/computeflavor.png similarity index 100% rename from docs/requirements/images/computeflavor.png rename to docs/development/requirements/images/computeflavor.png diff --git a/docs/requirements/images/figure1.png b/docs/development/requirements/images/figure1.png similarity index 100% rename from docs/requirements/images/figure1.png rename to docs/development/requirements/images/figure1.png diff --git a/docs/requirements/images/figure2.png b/docs/development/requirements/images/figure2.png similarity index 100% rename from docs/requirements/images/figure2.png rename to docs/development/requirements/images/figure2.png diff --git a/docs/requirements/images/figure3.png b/docs/development/requirements/images/figure3.png similarity index 100% rename from docs/requirements/images/figure3.png rename to docs/development/requirements/images/figure3.png diff --git a/docs/requirements/images/figure4.png b/docs/development/requirements/images/figure4.png similarity index 100% rename from docs/requirements/images/figure4.png rename to docs/development/requirements/images/figure4.png diff --git a/docs/requirements/images/figure5.png b/docs/development/requirements/images/figure5.png similarity index 100% rename from docs/requirements/images/figure5.png rename to docs/development/requirements/images/figure5.png diff --git a/docs/requirements/images/figure5_new.png b/docs/development/requirements/images/figure5_new.png similarity index 100% rename from docs/requirements/images/figure5_new.png rename to docs/development/requirements/images/figure5_new.png diff --git a/docs/requirements/images/figure6.png b/docs/development/requirements/images/figure6.png similarity index 100% rename from docs/requirements/images/figure6.png rename to docs/development/requirements/images/figure6.png diff --git a/docs/requirements/images/figure6_new.png b/docs/development/requirements/images/figure6_new.png similarity index 100% rename from docs/requirements/images/figure6_new.png rename to docs/development/requirements/images/figure6_new.png diff --git a/docs/requirements/images/figure7_new.png b/docs/development/requirements/images/figure7_new.png similarity index 100% rename from docs/requirements/images/figure7_new.png rename to docs/development/requirements/images/figure7_new.png diff --git a/docs/requirements/impl_architecture.rst b/docs/development/requirements/impl_architecture.rst similarity index 100% rename from docs/requirements/impl_architecture.rst rename to docs/development/requirements/impl_architecture.rst diff --git a/docs/requirements/index.rst b/docs/development/requirements/index.rst similarity index 100% rename from docs/requirements/index.rst rename to docs/development/requirements/index.rst diff --git a/docs/requirements/intro.rst b/docs/development/requirements/intro.rst similarity index 100% rename from docs/requirements/intro.rst rename to docs/development/requirements/intro.rst diff --git a/docs/requirements/references.rst b/docs/development/requirements/references.rst similarity index 100% rename from docs/requirements/references.rst rename to docs/development/requirements/references.rst diff --git a/docs/requirements/revision.rst b/docs/development/requirements/revision.rst similarity index 100% rename from docs/requirements/revision.rst rename to docs/development/requirements/revision.rst diff --git a/docs/requirements/schemas.rst b/docs/development/requirements/schemas.rst similarity index 100% rename from docs/requirements/schemas.rst rename to docs/development/requirements/schemas.rst diff --git a/docs/requirements/summary.rst b/docs/development/requirements/summary.rst similarity index 100% rename from docs/requirements/summary.rst rename to docs/development/requirements/summary.rst diff --git a/docs/requirements/supported_apis.rst b/docs/development/requirements/supported_apis.rst similarity index 100% rename from docs/requirements/supported_apis.rst rename to docs/development/requirements/supported_apis.rst diff --git a/docs/requirements/usecase.rst b/docs/development/requirements/usecase.rst similarity index 100% rename from docs/requirements/usecase.rst rename to docs/development/requirements/usecase.rst diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/release/configguide/feature.configuration.rst similarity index 100% rename from docs/installationprocedure/feature.configuration.rst rename to docs/release/configguide/feature.configuration.rst diff --git a/docs/installationprocedure/images/LICENSE b/docs/release/configguide/images/LICENSE similarity index 100% rename from docs/installationprocedure/images/LICENSE rename to docs/release/configguide/images/LICENSE diff --git a/docs/installationprocedure/images/screenshot_promise.png b/docs/release/configguide/images/screenshot_promise.png similarity index 100% rename from docs/installationprocedure/images/screenshot_promise.png rename to docs/release/configguide/images/screenshot_promise.png diff --git a/docs/installationprocedure/images/screenshot_promise_install.png b/docs/release/configguide/images/screenshot_promise_install.png similarity index 100% rename from docs/installationprocedure/images/screenshot_promise_install.png rename to docs/release/configguide/images/screenshot_promise_install.png diff --git a/docs/installationprocedure/index.rst b/docs/release/configguide/index.rst similarity index 100% rename from docs/installationprocedure/index.rst rename to docs/release/configguide/index.rst diff --git a/docs/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst similarity index 97% rename from docs/userguide/feature.userguide.rst rename to docs/release/userguide/feature.userguide.rst index 5fcae54..0a32270 100644 --- a/docs/userguide/feature.userguide.rst +++ b/docs/release/userguide/feature.userguide.rst @@ -6,7 +6,7 @@ Abstract This user guide document provides the users with: 1. Short description of Promise project and key features implemented in -Colorado. +Danube. Promise description =================== @@ -22,7 +22,7 @@ The following are the key features provided by this module: Promise capabilities and usage ============================== -The Colorado implementation of Promise is built with the YangForge data modeling +The Danube implementation of Promise is built with the YangForge data modeling framework [#f2]_ , using a shim-layer on top of OpenStack to provide the Promise features. This approach requires communication between Consumers/Administrators and OpenStack to pass through the shim-layer. The @@ -41,7 +41,7 @@ in the Promise requirement document [#f1]_ . Promise features and API usage guidelines and examples ------------------------------------------------------ -This section lists the Promise features and API implemented in OPNFV Colorado. +This section lists the Promise features and API implemented in OPNFV Danube. Note: The listed parameters are optional unless explicitly marked as "mandatory". @@ -156,7 +156,7 @@ The operation takes the following input parameters: * provider-id: identifier of the provider where the instance shall be created * reservation-id: identifier of a resource reservation the *create-instance* -The Colorado implementation of Promise has the following limitations: +The Danube implementation of Promise has the following limitations: * All create server instance requests shall pass through the Promise shim-layer such that Promise can keep track of all allocation requests. This @@ -263,7 +263,7 @@ The current implementation supports the following filter criteria: This API towards OpenStack allows a Consumer/Administrator to add and remove resource providers to Promise. Note, Promise supports a multi-provider -configuration, however, for Colorado, multi-provider support is not yet +configuration, however, for Danube, multi-provider support is not yet fully supported. *add-provider* @@ -272,7 +272,7 @@ fully supported. This operation is used to register a new resource provider into the Promise reservation system. -Note, for Colorado, the add-provider operation should only be used to +Note, for Danube, the add-provider operation should only be used to register one provider with the Promise shim-layer. Further note that currently only OpenStack is supported as a provider. diff --git a/docs/userguide/index.rst b/docs/release/userguide/index.rst similarity index 100% rename from docs/userguide/index.rst rename to docs/release/userguide/index.rst