From: Yifei Xue Date: Thu, 24 Aug 2017 13:50:22 +0000 (+0800) Subject: Docs update for E release X-Git-Tag: opnfv-5.0.0~28 X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=c450b54ffb461e5a9a157b13679686170f7c385d;p=compass4nfv.git Docs update for E release JIRA: - Update the structure of docs directory. Update the docs for E release. Add some new docs for E release. Change-Id: Ib4b6aced3d6ac88404d8518b5461e20d26e017e1 Signed-off-by: Yifei Xue --- diff --git a/docs/development/index.rst b/docs/development/index.rst new file mode 100644 index 00000000..734fe961 --- /dev/null +++ b/docs/development/index.rst @@ -0,0 +1,18 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2017 OPNFV. + + +=========== +Compass4NFV +=========== + +.. toctree:: + :maxdepth: 2 + + ./overview/index.rst + ./design/index.rst + +Indices +======= +* :ref:`search` diff --git a/docs/development/overview/containerized_compass.rst b/docs/development/overview/containerized_compass.rst new file mode 100644 index 00000000..de3ec902 --- /dev/null +++ b/docs/development/overview/containerized_compass.rst @@ -0,0 +1,6 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) by Justin Chi (HUAWEI) and Yifei Xue (HUAWEI) + +Introduction of Containerized Compass +===================================== diff --git a/docs/development/overview/index.rst b/docs/development/overview/index.rst new file mode 100644 index 00000000..56e3a550 --- /dev/null +++ b/docs/development/overview/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 + +.. _compass4nfv-overview: + +********************************* +Compass4NFV Development Overview +********************************* + +.. toctree:: + :maxdepth: 2 + + containerized_compass.rst diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst new file mode 100644 index 00000000..fae27101 --- /dev/null +++ b/docs/release/configguide/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 + +.. _compass4nfv-overview: + +********************************* +Compass4NFV Release Overview +********************************* + +.. toctree:: + :maxdepth: 2 + + containerized_compass.rst diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index 44678b87..99e18b54 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -2,7 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Weidong Shao (HUAWEI) and Justin Chi (HUAWEI) -Release Note for the Danube release of OPNFV when using Compass4nfv as a deployment tool. +Release Note for the Euphrates release of OPNFV when using Compass4nfv as a deployment tool. Abstract ======== @@ -25,16 +25,16 @@ Release Data | **Project** | Compass4nfv | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | Compass4nfv/Danube.1.0 | +| **Repo/tag** | Compass4nfv/Euphrates.1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Danube.1.0 | +| **Release designation** | Euphrates.1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | March 31 2017 | +| **Release date** | September 2017 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | OPNFV Danube release | +| **Purpose of the delivery** | OPNFV Euphrates release | | | | +--------------------------------------+--------------------------------------+ @@ -44,16 +44,16 @@ Deliverables Software deliverables ~~~~~~~~~~~~~~~~~~~~~ - - Compass4nfv/Danube.1.0 ISO, please get it from `OPNFV software download page `_ + - Compass4nfv/Euphrates.1.0 tarball, please get it from `OPNFV software download page `_ .. _document-label: Documentation deliverables ~~~~~~~~~~~~~~~~~~~~~~~~~~ - - OPNFV(Danube) Compass4nfv installation instructions + - OPNFV(Euphrates) Compass4nfv installation instructions - - OPNFV(Danube) Compass4nfv Release Notes + - OPNFV(Euphrates) Compass4nfv Release Notes Version change -------------- @@ -62,21 +62,20 @@ Version change Module version change ~~~~~~~~~~~~~~~~~~~~~ -This is the Danube release of compass4nfv as a deployment toolchain in OPNFV, the following +This is the Euphrates release of compass4nfv as a deployment toolchain in OPNFV, the following upstream components supported with this release. - Ubuntu 16.04/Centos 7.3 - - Openstack (Newton release) + - Openstack (Ocata release) - - Opendaylight (Boron SR2 release) + - Opendaylight (Nitrogen release) - - ONOS (J-bird release/later release) Document version change ~~~~~~~~~~~~~~~~~~~~~~~ -Adjusted the document structure, and you can see document at `OPNFV(Danube) Compass4nfv installation instructions `_. +Adjusted the document structure, and you can see document at `OPNFV(Euphrates) Compass4nfv installation instructions `_. Reason for new version ---------------------- @@ -145,7 +144,7 @@ Known issues Test Result =========== -The Danube release with the Compass4nfv deployment toolchain has undergone QA test +The Euphrates release with the Compass4nfv deployment toolchain has undergone QA test runs with the following results: Functest: http://testresults.opnfv.org/reporting/functest/release/danube/index-status-compass.html diff --git a/docs/release/scenarios/index.rst b/docs/release/scenarios/index.rst new file mode 100644 index 00000000..a00eb44a --- /dev/null +++ b/docs/release/scenarios/index.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 + +.. _compass4nfv-scenarios: + +********************* +Compass4NFV Scenarios +********************* + +.. toctree:: + :maxdepth: 2 + + os-nosdn-nofeature-ha.rst + os-odl-nofeature-ha.rst + diff --git a/docs/release/FAQ/faq.rst b/docs/release/userguide/FAQ/faq.rst similarity index 100% rename from docs/release/FAQ/faq.rst rename to docs/release/userguide/FAQ/faq.rst diff --git a/docs/release/FAQ/index.rst b/docs/release/userguide/FAQ/index.rst similarity index 100% rename from docs/release/FAQ/index.rst rename to docs/release/userguide/FAQ/index.rst