From: Rich Bennett Date: Thu, 19 Jul 2018 21:16:21 +0000 (+0000) Subject: Merge "Update INFO.yaml" X-Git-Tag: elalto.1.5.2~12480 X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=06bcf32744ec7eb6ed67646086f3880dcdef6be5;hp=ee51900b75a1b426dea3afa26c3bffa87e8f90fe;p=doc.git Merge "Update INFO.yaml" --- diff --git a/docs/conf.py b/docs/conf.py index 815d0d0a3..f81a78b43 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -38,6 +38,7 @@ extensions = [ 'sphinx.ext.imgmath', 'sphinx.ext.viewcode', 'sphinxcontrib.blockdiag', + 'sphinxcontrib.needs', 'sphinxcontrib.nwdiag', 'sphinxcontrib.seqdiag', 'sphinx.ext.ifconfig', @@ -426,3 +427,64 @@ linkcheck_ignore = [ r'https://we-are-data-router.us', r'https://we-are-message-router.us:\d+/' ] + +from docutils.parsers.rst import directives + +needs_extra_options = { + "target": directives.unchanged, + "keyword": directives.unchanged, + "introduced": directives.unchanged, + "updated": directives.unchanged, + "impacts": directives.unchanged, + "validation_mode": directives.unchanged, + "validated_by": directives.unchanged, + "test": directives.unchanged, + "test_case": directives.unchanged, + "test_file": directives.unchanged, + "notes": directives.unchanged, +} + +needs_id_regex = "^[A-Z0-9]+-[A-Z0-9]+" +needs_id_required = True +needs_title_optional = True + +needs_template_collapse = """ +.. _{{id}}: + +{% if hide == false -%} +.. role:: needs_tag +.. role:: needs_status +.. role:: needs_type +.. role:: needs_id +.. role:: needs_title + +.. rst-class:: need +.. rst-class:: need_{{type_name}} + +.. container:: need + + `{{id}}` - {{content|indent(4)}} + + .. container:: toggle + + .. container:: header + + Details + +{% if status and status|upper != "NONE" and not hide_status %} | status: :needs_status:`{{status}}`{% endif %} +{% if tags and not hide_tags %} | tags: :needs_tag:`{{tags|join("` :needs_tag:`")}}`{% endif %} +{% if keyword %} | keyword: `{{keyword}}` {% endif %} +{% if target %} | target: `{{target}}` {% endif %} +{% if introduced %} | introduced: `{{introduced}}` {% endif %} +{% if updated %} | updated: `{{updated}}` {% endif %} +{% if impacts %} | impacts: `{{impacts}}` {% endif %} +{% if validation_mode %} | validation mode: `{{validation_mode}}` {% endif %} +{% if validated_by %} | validated by: `{{validated_by}}` {% endif %} +{% if test %} | test: `{{test}}` {% endif %} +{% if test_case %} | test case: {{test_case}} {% endif %} +{% if test_file %} | test file: `{{test_file}}` {% endif %} +{% if notes %} | notes: `{{notes}}` {% endif %} + | children: :need_incoming:`{{id}}` + | parents: :need_outgoing:`{{id}}` +{% endif -%} +""" diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 331248c2f..3524cf652 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -190,6 +190,17 @@ ONAP Operations Manager (experimental) ../../../submodules/oom.git/docs/index +ONAP Optimization Framework +-------------------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/optf/has.git/docs/index + ../../../submodules/optf/osdf.git/docs/index + + ONAP Use Case User Interface ---------------------------- diff --git a/docs/guides/onap-developer/how-to-use-docs/style-guide.rst b/docs/guides/onap-developer/how-to-use-docs/style-guide.rst index 74fc261c1..324688551 100644 --- a/docs/guides/onap-developer/how-to-use-docs/style-guide.rst +++ b/docs/guides/onap-developer/how-to-use-docs/style-guide.rst @@ -118,3 +118,27 @@ Tasks - Break down end-to-end tasks into manageable chunks. + +ONAP Conventions for the Use of Sphinx Directives +------------------------------------------------- + +Needs Directive +^^^^^^^^^^^^^^^ + + * Needs IDs must match the regular expression "^[A-Z0-9]+-[A-Z0-9]+" + + * The prefix (string before the dash) must be described in the following table + +.. list-table:: Needs Prefix Use + :align: center + :widths: 8 40 40 + :header-rows: 1 + + * - Prefix + - Description + - Use + + * - R + - Represents a requirement that must be met by a VNF provider + - Defined only in the vnfrqts project repositories, may be referenced in any project repository source + diff --git a/docs/guides/onap-developer/settingup/onap_heat.rst b/docs/guides/onap-developer/settingup/onap_heat.rst index 833393d33..afbbd6bf8 100644 --- a/docs/guides/onap-developer/settingup/onap_heat.rst +++ b/docs/guides/onap-developer/settingup/onap_heat.rst @@ -408,7 +408,7 @@ command: ======================== The current ONAP installation is using the *onap.org* domain. To use the portal on your desktop, you must configure the following information -in your *host* file (located in /etc/host for Linux or +in your *host* file (located in /etc/hosts for Linux or /windows/system32/drivers/etc/hosts for Windows): .. code-block:: bash diff --git a/docs/submodules/aaf/authz.git b/docs/submodules/aaf/authz.git index b7440251f..32cdd553a 160000 --- a/docs/submodules/aaf/authz.git +++ b/docs/submodules/aaf/authz.git @@ -1 +1 @@ -Subproject commit b7440251f26be4e879ae607c3981a3799b8b3909 +Subproject commit 32cdd553a8668e6d03a9cf5b11b360d35a63c87f diff --git a/docs/submodules/aaf/sms.git b/docs/submodules/aaf/sms.git index 8eb91b97b..15f771a0c 160000 --- a/docs/submodules/aaf/sms.git +++ b/docs/submodules/aaf/sms.git @@ -1 +1 @@ -Subproject commit 8eb91b97baac63b085a8d75407b85841ff9f4444 +Subproject commit 15f771a0cdada988f44b604b9baa30c8b374cab2 diff --git a/docs/submodules/aai/aai-common.git b/docs/submodules/aai/aai-common.git index 75370173d..dd29b7fa9 160000 --- a/docs/submodules/aai/aai-common.git +++ b/docs/submodules/aai/aai-common.git @@ -1 +1 @@ -Subproject commit 75370173d19e97967d34b3c117f1e3c0820c2553 +Subproject commit dd29b7fa91d835a29b62e078a53bc82a6d0c4c10 diff --git a/docs/submodules/aai/esr-gui.git b/docs/submodules/aai/esr-gui.git index 767c14f43..f3872f1f9 160000 --- a/docs/submodules/aai/esr-gui.git +++ b/docs/submodules/aai/esr-gui.git @@ -1 +1 @@ -Subproject commit 767c14f4326941170683bbc3ed6a69fe3725b459 +Subproject commit f3872f1f9c21a83eebfbed4c4910e28b9f02d24a diff --git a/docs/submodules/aai/esr-server.git b/docs/submodules/aai/esr-server.git index 801522fa8..7f8d027dd 160000 --- a/docs/submodules/aai/esr-server.git +++ b/docs/submodules/aai/esr-server.git @@ -1 +1 @@ -Subproject commit 801522fa8e8c14a92bc7078b7afa8ebc3c4be36b +Subproject commit 7f8d027ddd80f41004ac93b47caa7f7c8721601a diff --git a/docs/submodules/aai/event-client.git b/docs/submodules/aai/event-client.git index 95c897c3c..5482cee27 160000 --- a/docs/submodules/aai/event-client.git +++ b/docs/submodules/aai/event-client.git @@ -1 +1 @@ -Subproject commit 95c897c3c85c305f676dc04adc2f167fecfc598b +Subproject commit 5482cee27404b6d545a3f1e9714d0076e811b4bd diff --git a/docs/submodules/aai/sparky-be.git b/docs/submodules/aai/sparky-be.git index 41a0983d5..f42670da7 160000 --- a/docs/submodules/aai/sparky-be.git +++ b/docs/submodules/aai/sparky-be.git @@ -1 +1 @@ -Subproject commit 41a0983d5dd3707b5fd2c86dcc0b4b0c399bd40f +Subproject commit f42670da77dabfb638c6b180ac7133ec869ecc69 diff --git a/docs/submodules/appc.git b/docs/submodules/appc.git index 80941b3f8..13591a022 160000 --- a/docs/submodules/appc.git +++ b/docs/submodules/appc.git @@ -1 +1 @@ -Subproject commit 80941b3f869da79f3c3f2a79be77aab0180c574e +Subproject commit 13591a022d59d11d1301c459ab66b8e2abb8ac47 diff --git a/docs/submodules/appc/deployment.git b/docs/submodules/appc/deployment.git index cc3142b7f..536c49b27 160000 --- a/docs/submodules/appc/deployment.git +++ b/docs/submodules/appc/deployment.git @@ -1 +1 @@ -Subproject commit cc3142b7f07c697167ace366887acb2836bb48ef +Subproject commit 536c49b27d07ada858e152fefd036b6d6060ecb4 diff --git a/docs/submodules/ccsdk/distribution.git b/docs/submodules/ccsdk/distribution.git index 056e82aa2..ea56542af 160000 --- a/docs/submodules/ccsdk/distribution.git +++ b/docs/submodules/ccsdk/distribution.git @@ -1 +1 @@ -Subproject commit 056e82aa242f7df59c72dc967f38d479c51f7509 +Subproject commit ea56542af7139307acd2c9a6476e04ac40c278be diff --git a/docs/submodules/ccsdk/parent.git b/docs/submodules/ccsdk/parent.git index 8cc38860e..13293d901 160000 --- a/docs/submodules/ccsdk/parent.git +++ b/docs/submodules/ccsdk/parent.git @@ -1 +1 @@ -Subproject commit 8cc38860e74391e8efd732ced4a8e14fc8dc8218 +Subproject commit 13293d90149b41ad29f76f1303c23c124109b1e9 diff --git a/docs/submodules/ccsdk/platform/plugins.git b/docs/submodules/ccsdk/platform/plugins.git index cec8e7c0f..c5552def0 160000 --- a/docs/submodules/ccsdk/platform/plugins.git +++ b/docs/submodules/ccsdk/platform/plugins.git @@ -1 +1 @@ -Subproject commit cec8e7c0f90be290796d9a666edeea97e118a26f +Subproject commit c5552def064cc4643ac879ec5f116c27f4cd088e diff --git a/docs/submodules/clamp.git b/docs/submodules/clamp.git index 21ebe86d8..b0ff445fb 160000 --- a/docs/submodules/clamp.git +++ b/docs/submodules/clamp.git @@ -1 +1 @@ -Subproject commit 21ebe86d82cb7e7700e45df9873ef5ca1834fc76 +Subproject commit b0ff445fb7b53db882997ec0fd0e843b5c92a413 diff --git a/docs/submodules/dcaegen2.git b/docs/submodules/dcaegen2.git index eaac78d80..9d02e4106 160000 --- a/docs/submodules/dcaegen2.git +++ b/docs/submodules/dcaegen2.git @@ -1 +1 @@ -Subproject commit eaac78d809a0a019718cb8b070f496b6883bb130 +Subproject commit 9d02e4106fd08585d12999faf72867fafe6ce007 diff --git a/docs/submodules/dmaap/dbcapi.git b/docs/submodules/dmaap/dbcapi.git index 955500a4a..f595e173f 160000 --- a/docs/submodules/dmaap/dbcapi.git +++ b/docs/submodules/dmaap/dbcapi.git @@ -1 +1 @@ -Subproject commit 955500a4aa5c86a1ccc8c4bdf81c65daff41070a +Subproject commit f595e173fdb3921cb6c6855f5389871ee3c3ada3 diff --git a/docs/submodules/externalapi/nbi.git b/docs/submodules/externalapi/nbi.git index a42cd6851..9dc24ae6e 160000 --- a/docs/submodules/externalapi/nbi.git +++ b/docs/submodules/externalapi/nbi.git @@ -1 +1 @@ -Subproject commit a42cd685193bd9156a25fe0708ba8c4a30664137 +Subproject commit 9dc24ae6efc0d070ae446b87c6268bb3cd353034 diff --git a/docs/submodules/holmes/engine-management.git b/docs/submodules/holmes/engine-management.git index 8490a957d..d70f48853 160000 --- a/docs/submodules/holmes/engine-management.git +++ b/docs/submodules/holmes/engine-management.git @@ -1 +1 @@ -Subproject commit 8490a957d5200419a0b8e60c35d8b2c7ecb1ba6e +Subproject commit d70f48853bf9ab690f3019b1682c422a6854fd8b diff --git a/docs/submodules/holmes/rule-management.git b/docs/submodules/holmes/rule-management.git index 56c8610f7..0b1df79ef 160000 --- a/docs/submodules/holmes/rule-management.git +++ b/docs/submodules/holmes/rule-management.git @@ -1 +1 @@ -Subproject commit 56c8610f708a4f6a20cb86428a88d917289fb651 +Subproject commit 0b1df79ef7749d62b4412e5433538d32feb6850c diff --git a/docs/submodules/integration.git b/docs/submodules/integration.git index b1d31973d..2ad758024 160000 --- a/docs/submodules/integration.git +++ b/docs/submodules/integration.git @@ -1 +1 @@ -Subproject commit b1d31973db0cf699ef65d862c2fcf02177aafac5 +Subproject commit 2ad7580242d28496a875dbceeacad546e58c7201 diff --git a/docs/submodules/logging-analytics.git b/docs/submodules/logging-analytics.git index f78f68dc8..af1410de6 160000 --- a/docs/submodules/logging-analytics.git +++ b/docs/submodules/logging-analytics.git @@ -1 +1 @@ -Subproject commit f78f68dc817cbbf76f2d65e68c955f0ec3e65d2d +Subproject commit af1410de64d463905dd6deee62efdd88ff616ce8 diff --git a/docs/submodules/msb/apigateway.git b/docs/submodules/msb/apigateway.git index 21253185c..d4abfa7ac 160000 --- a/docs/submodules/msb/apigateway.git +++ b/docs/submodules/msb/apigateway.git @@ -1 +1 @@ -Subproject commit 21253185c17ef038e71146112fc948b7c9ad572f +Subproject commit d4abfa7ac6ec1a3495dfd655379acf8e9262885c diff --git a/docs/submodules/multicloud/framework.git b/docs/submodules/multicloud/framework.git index f58274713..87e46652b 160000 --- a/docs/submodules/multicloud/framework.git +++ b/docs/submodules/multicloud/framework.git @@ -1 +1 @@ -Subproject commit f58274713412c8932e69ff41eb01244e65bffd31 +Subproject commit 87e46652b3f319d0b63df22e6782775d5c6ce3d8 diff --git a/docs/submodules/music.git b/docs/submodules/music.git index 5e5d6ed9b..9b6efbd93 160000 --- a/docs/submodules/music.git +++ b/docs/submodules/music.git @@ -1 +1 @@ -Subproject commit 5e5d6ed9badebfbc1cc65a90e3de8dad232f9e42 +Subproject commit 9b6efbd93a12c858a0d2643013217ec3d6c3a46d diff --git a/docs/submodules/oom.git b/docs/submodules/oom.git index 060359c28..154a54018 160000 --- a/docs/submodules/oom.git +++ b/docs/submodules/oom.git @@ -1 +1 @@ -Subproject commit 060359c287c7a328804a9a6012cbbede3219562b +Subproject commit 154a540188bb212a5e431e91e02044c661ae3c02 diff --git a/docs/submodules/optf/has.git b/docs/submodules/optf/has.git index a783f589b..1d048cfce 160000 --- a/docs/submodules/optf/has.git +++ b/docs/submodules/optf/has.git @@ -1 +1 @@ -Subproject commit a783f589b9cc06e10f6eed93ede754353eb6e720 +Subproject commit 1d048cfce20317c3beb85519c198e8d114b1c819 diff --git a/docs/submodules/optf/osdf.git b/docs/submodules/optf/osdf.git index 9fe615529..2fc33e423 160000 --- a/docs/submodules/optf/osdf.git +++ b/docs/submodules/optf/osdf.git @@ -1 +1 @@ -Subproject commit 9fe615529a9fb71d347a5ef6fd88768a45bfa680 +Subproject commit 2fc33e4237e0dc0a383efc4ff04a2ba334799744 diff --git a/docs/submodules/policy/engine.git b/docs/submodules/policy/engine.git index 1577c271f..9bfa1d61d 160000 --- a/docs/submodules/policy/engine.git +++ b/docs/submodules/policy/engine.git @@ -1 +1 @@ -Subproject commit 1577c271f66912e13770eb3950a25ae40cf9c4ad +Subproject commit 9bfa1d61dc77973f85a42174b199d4c744265521 diff --git a/docs/submodules/portal.git b/docs/submodules/portal.git index 4072269d9..fe3a67c11 160000 --- a/docs/submodules/portal.git +++ b/docs/submodules/portal.git @@ -1 +1 @@ -Subproject commit 4072269d9f6b452aaff41fc02b09bfca40356dd5 +Subproject commit fe3a67c11b65d7989a6ef648c3f34eee8abe7394 diff --git a/docs/submodules/sdc.git b/docs/submodules/sdc.git index 1a7d92fbe..d0eaecace 160000 --- a/docs/submodules/sdc.git +++ b/docs/submodules/sdc.git @@ -1 +1 @@ -Subproject commit 1a7d92fbe4118e74a6a57872c920ad83ee05650d +Subproject commit d0eaecacec822c0332a31f499f9d972c9b39e691 diff --git a/docs/submodules/sdc/jtosca.git b/docs/submodules/sdc/jtosca.git index 718f5b1ab..842633530 160000 --- a/docs/submodules/sdc/jtosca.git +++ b/docs/submodules/sdc/jtosca.git @@ -1 +1 @@ -Subproject commit 718f5b1ab6d4338b6128671d558034eddfd139d8 +Subproject commit 842633530e7c1615f988cf58fcc9b472fe5b5fe1 diff --git a/docs/submodules/sdc/sdc-tosca.git b/docs/submodules/sdc/sdc-tosca.git index c3faa4984..470b614cd 160000 --- a/docs/submodules/sdc/sdc-tosca.git +++ b/docs/submodules/sdc/sdc-tosca.git @@ -1 +1 @@ -Subproject commit c3faa49849665b4e84c058e9ac1bf12c280299ba +Subproject commit 470b614cd002e78155944b653ac1e2f974521079 diff --git a/docs/submodules/sdc/sdc-workflow-designer.git b/docs/submodules/sdc/sdc-workflow-designer.git index 16c48c296..7b29a376f 160000 --- a/docs/submodules/sdc/sdc-workflow-designer.git +++ b/docs/submodules/sdc/sdc-workflow-designer.git @@ -1 +1 @@ -Subproject commit 16c48c29687bef763299321057767ff1fdcb0d4d +Subproject commit 7b29a376f0b211dccc35cb1d7f73e011bcad016b diff --git a/docs/submodules/sdnc/oam.git b/docs/submodules/sdnc/oam.git index 110b9d3f1..86a008a5b 160000 --- a/docs/submodules/sdnc/oam.git +++ b/docs/submodules/sdnc/oam.git @@ -1 +1 @@ -Subproject commit 110b9d3f108e8f81f705ec4eeb2102f98f220d39 +Subproject commit 86a008a5b0f0f22356f64b86d9c4c51f9cf09cdc diff --git a/docs/submodules/so.git b/docs/submodules/so.git index 1336ef0cc..3a7c2f77e 160000 --- a/docs/submodules/so.git +++ b/docs/submodules/so.git @@ -1 +1 @@ -Subproject commit 1336ef0ccd540266b63924d9aad4d375dc74b79b +Subproject commit 3a7c2f77e9d045e31139aee67dffe25a7add49f2 diff --git a/docs/submodules/vfc/nfvo/driver/vnfm/svnfm.git b/docs/submodules/vfc/nfvo/driver/vnfm/svnfm.git index ea20ae71a..7d894a773 160000 --- a/docs/submodules/vfc/nfvo/driver/vnfm/svnfm.git +++ b/docs/submodules/vfc/nfvo/driver/vnfm/svnfm.git @@ -1 +1 @@ -Subproject commit ea20ae71a0c2bd88d155afaed03ef7aed3e6b5c1 +Subproject commit 7d894a773aedd079e7b65414299334982a38532d diff --git a/docs/submodules/vfc/nfvo/lcm.git b/docs/submodules/vfc/nfvo/lcm.git index fa5ce7129..ce4a4fa0b 160000 --- a/docs/submodules/vfc/nfvo/lcm.git +++ b/docs/submodules/vfc/nfvo/lcm.git @@ -1 +1 @@ -Subproject commit fa5ce71293ba07ee8f0978fa81ab97c6bf26dfc2 +Subproject commit ce4a4fa0bef0fbede2e6d55460091ebe5cdf0f67 diff --git a/docs/submodules/vid.git b/docs/submodules/vid.git index 39a5994da..ff76b5ed0 160000 --- a/docs/submodules/vid.git +++ b/docs/submodules/vid.git @@ -1 +1 @@ -Subproject commit 39a5994da3b9b6c900e16c5c4b015e1aea780adc +Subproject commit ff76b5ed0aa91d5fdf9dc4f95e8b20f91ed9d072 diff --git a/docs/submodules/vnfrqts/guidelines.git b/docs/submodules/vnfrqts/guidelines.git index e5d69d664..75fc8abdf 160000 --- a/docs/submodules/vnfrqts/guidelines.git +++ b/docs/submodules/vnfrqts/guidelines.git @@ -1 +1 @@ -Subproject commit e5d69d664eb5a0af499ca2941f2e415778c945af +Subproject commit 75fc8abdfa55e7aef77a006e03853f2180901850 diff --git a/docs/submodules/vnfrqts/requirements.git b/docs/submodules/vnfrqts/requirements.git index fe3390395..2fc6ebc53 160000 --- a/docs/submodules/vnfrqts/requirements.git +++ b/docs/submodules/vnfrqts/requirements.git @@ -1 +1 @@ -Subproject commit fe3390395d97f1a0fe2e8f4ab5cd8a3d08070958 +Subproject commit 2fc6ebc537028f72788cf7b169970e1aa3ddfbb0 diff --git a/docs/submodules/vnfrqts/testcases.git b/docs/submodules/vnfrqts/testcases.git index cdc4c8d54..3ade6cdb4 160000 --- a/docs/submodules/vnfrqts/testcases.git +++ b/docs/submodules/vnfrqts/testcases.git @@ -1 +1 @@ -Subproject commit cdc4c8d541d2962868cd146084c79bd02482a6d2 +Subproject commit 3ade6cdb4282277c68dd599f0f03aab8d1bd4615 diff --git a/docs/submodules/vnfrqts/usecases.git b/docs/submodules/vnfrqts/usecases.git index 092c7be21..dd8908a9f 160000 --- a/docs/submodules/vnfrqts/usecases.git +++ b/docs/submodules/vnfrqts/usecases.git @@ -1 +1 @@ -Subproject commit 092c7be21635f9423f2b4383164f3286a76f8964 +Subproject commit dd8908a9fd4182ba87dad31f3bfe09dbaed5b92e diff --git a/docs/submodules/vvp/documentation.git b/docs/submodules/vvp/documentation.git index c85a341c7..6dee9df5b 160000 --- a/docs/submodules/vvp/documentation.git +++ b/docs/submodules/vvp/documentation.git @@ -1 +1 @@ -Subproject commit c85a341c7a00c910a737d50d3f11cd8f923c6641 +Subproject commit 6dee9df5bf854047df8b1c0944dad13f77d0c9ee diff --git a/etc/requirements.txt b/etc/requirements.txt index 4b8679121..8e2894c62 100644 --- a/etc/requirements.txt +++ b/etc/requirements.txt @@ -6,6 +6,7 @@ setuptools six sphinx_rtd_theme sphinxcontrib-blockdiag +sphinxcontrib-needs>=0.2.3 sphinxcontrib-nwdiag sphinxcontrib-seqdiag sphinxcontrib-swaggerdoc