summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMorgan Richomme <morgan.richomme@orange.com>2016-09-19 11:17:36 +0200
committerMorgan Richomme <morgan.richomme@orange.com>2016-09-19 11:25:35 +0200
commitc4895122dc3d3ea2d744660a9106c1c297b7b854 (patch)
tree4b238fbb14ddf1a341b7b4e38ae5869d8557ea09 /docs
parent1cd3f2d4abaf4e936c9f1dea7b79e1f7fee84575 (diff)
Remove TODO in Functest user guide
- Add links to feature project user guide - Add links to external web site - Change Dashboard picture JIRA: FUNCTEST-434 Change-Id: Ifc760c376361ed5452a874e373767b51d761b91f Signed-off-by: Morgan Richomme <morgan.richomme@orange.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/images/FunctestDashboardColorado.pngbin0 -> 142728 bytes
-rw-r--r--docs/userguide/index.rst18
-rw-r--r--docs/userguide/introduction.rst24
-rw-r--r--docs/userguide/troubleshooting.rst2
4 files changed, 25 insertions, 19 deletions
diff --git a/docs/images/FunctestDashboardColorado.png b/docs/images/FunctestDashboardColorado.png
new file mode 100644
index 000000000..6ef90d941
--- /dev/null
+++ b/docs/images/FunctestDashboardColorado.png
Binary files differ
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
index 314ae225b..d2467df71 100644
--- a/docs/userguide/index.rst
+++ b/docs/userguide/index.rst
@@ -329,14 +329,14 @@ be declared in its own repository as well.
Please refer to the dedicated feature user guides for details:
- * bgpvpn: ** TODO link **
+ * bgpvpn: http://artifacts.opnfv.org/sdnvpn/colorado/docs/userguide/index.html
* copper: http://artifacts.opnfv.org/copper/colorado/docs/userguide/index.html
* doctor: http://artifacts.opnfv.org/doctor/colorado/userguide/index.html
- * domino: ** TODO link **
- * moon: ** TODO link **
- * multisites: ** TODO link **
- * onos-sfc: ** TODO link **
- * odl-sfc: ** TODO link **
+ * domino: http://artifacts.opnfv.org/domino/docs/userguide-single/index.html
+ * moon: http://artifacts.opnfv.org/moon/docs/userguide/index.html
+ * multisites: http://artifacts.opnfv.org/multisite/docs/userguide/index.html
+ * onos-sfc: http://artifacts.opnfv.org/onosfw/colorado/userguide/index.html
+ * odl-sfc: http://artifacts.opnfv.org/sfc/colorado/userguide/index.html
* promise: http://artifacts.opnfv.org/promise/colorado/docs/userguide/index.html
security_scan
@@ -481,7 +481,7 @@ Based on results collected in CI, a test dashboard is dynamically generated.
References
==========
-.. _`[1]`: http://artifacts.opnfv.org/functest/docs/configguide/#
+.. _`[1]`: http://artifacts.opnfv.org/functest/colorado/docs/configguide/#
.. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html
.. _`[3]`: https://rally.readthedocs.org/en/latest/index.html
.. _`[4]`: http://events.linuxfoundation.org/sites/events/files/slides/Functest%20in%20Depth_0.pdf
@@ -490,7 +490,7 @@ References
.. _`[7]`: https://github.com/OpenSCAP/openscap
.. _`[9]`: https://git.opnfv.org/cgit/functest/tree/testcases/VIM/OpenStack/CI/libraries/os_defaults.yaml
.. _`[11]`: http://robotframework.org/
-.. _`[12]`: http://artifacts.opnfv.org/parser/docs/userguide/index.html
+.. _`[12]`: http://artifacts.opnfv.org/parser/colorado/docs/userguide/index.html
OPNFV main site: opnfvmain_.
@@ -504,4 +504,4 @@ IRC support chan: #opnfv-testperf
.. _`Rally installation procedure`: https://rally.readthedocs.org/en/latest/tutorial/step_0_installation.html
.. _`config_test.py` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.py
.. _`config_functest.yaml` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.yaml
-.. _`Functest reporting`: http://testresults.opnfv.org/reporting/functest/release/master/index-status-fuel.html
+.. _`Functest reporting`: http://testresults.opnfv.org/reporting/functest/release/colorado/index-status-fuel.html
diff --git a/docs/userguide/introduction.rst b/docs/userguide/introduction.rst
index 3e993a985..76aadc842 100644
--- a/docs/userguide/introduction.rst
+++ b/docs/userguide/introduction.rst
@@ -104,10 +104,11 @@ Features and VNF (Virtual Network Functions).
| | | | installer environment) |
| | +----------------+----------------------------------+
| | | onos-sfc | SFC testing for onos scenarios |
-| | | | TODO See for details |
+| | | | See `ONOSFW User Guide`_ for |
+| | | | details |
| | +----------------+----------------------------------+
| | | odl-sfc | SFC testing for odl scenarios |
-| | | | TODO See for details |
+| | | | See `SFC User Guide`_ for details|
| | +----------------+----------------------------------+
| | | domino | Domino provides TOSCA template |
| | | | distribution service for network |
@@ -131,10 +132,12 @@ Features and VNF (Virtual Network Functions).
| | | | in the `Copper User Guide`_. |
| | +----------------+----------------------------------+
| | | multisites | Multisites |
-| | | | TODO See for details |
+| | | | See `Multisite User Guide`_ for |
+| | | | details |
| | +----------------+----------------------------------+
| | | moon | Security management system |
-| | | | TODO See for details |
+| | | | See `Moon User Guide`_ for |
+| | | | details |
+-------------+---------------+----------------+----------------------------------+
| VNF | vnf | vims | Example of a real VNF deployment |
| | | | to show the NFV capabilities of |
@@ -183,7 +186,7 @@ NoSQL database. The goal is to populate the database with results from different
sources and scenarios and to show them on a `Functest Dashboard`_. A screenshot
of a live Functest Dashboard is shown below:
-.. figure:: ../images/FunctestDashboard.png
+.. figure:: ../images/FunctestDashboardColorado.png
:align: center
:alt: Functest Dashboard
@@ -221,8 +224,11 @@ section `Executing the functest suites`_ of this document.
.. _`Copper User Guide`: http://artifacts.opnfv.org/copper/colorado/docs/userguide/index.html
.. _`Doctor User Guide`: http://artifacts.opnfv.org/doctor/colorado/userguide/index.html
.. _`Promise User Guide`: http://artifacts.opnfv.org/promise/colorado/docs/userguide/index.html
-.. _`ONOSFW User Guide`: http://artifacts.opnfv.org/onosfw/brahmaputra/docs/userguide/index.html
-.. _`SDNVPN User Guide`: http://artifacts.opnfv.org/sdnvpn/brahmaputra/docs/userguide/featureusage.html
-.. _`Domino User Guide`: http://artifacts.opnfv.org/domino/docs/userguide/index.html
-.. _`Parser User Guide`: http://artifacts.opnfv.org/parser/docs/userguide/index.html
+.. _`ONOSFW User Guide`: http://artifacts.opnfv.org/onosfw/colorado/userguide/index.html
+.. _`SDNVPN User Guide`: http://artifacts.opnfv.org/sdnvpn/colorado/docs/userguide/index.html
+.. _`Domino User Guide`: http://artifacts.opnfv.org/domino/docs/userguide-single/index.html
+.. _`Parser User Guide`: http://artifacts.opnfv.org/parser/colorado/docs/userguide/index.html
.. _`Functest Dashboard`: http://testresults.opnfv.org/kibana_dashboards/
+.. _`SFC User Guide`: http://artifacts.opnfv.org/sfc/colorado/userguide/index.html
+.. _`Multisite User Guide`: http://artifacts.opnfv.org/multisite/docs/userguide/index.html
+.. _`Moon User Guide`: http://artifacts.opnfv.org/moon/docs/userguide/index.html
diff --git a/docs/userguide/troubleshooting.rst b/docs/userguide/troubleshooting.rst
index 0288d295c..dbbcc5d69 100644
--- a/docs/userguide/troubleshooting.rst
+++ b/docs/userguide/troubleshooting.rst
@@ -341,7 +341,7 @@ Please refer to the dedicated feature user guides for details.
security_scan
^^^^^^^^^^^^^
-** TODO **
+See OpenSCAP web site: https://www.open-scap.org/