From d1f93f4febdd5b34e96b954dd11e635bc0ee8041 Mon Sep 17 00:00:00 2001 From: "Lovett, Trevor" Date: Thu, 2 Jul 2020 11:19:00 -0500 Subject: Requirement ID Generation and RST Validation The new check.py script will now perform a variety of actions to simplify updates and ensure specific practices are followed for each update. The script has been integrated with tox and will run whenever the documentation is created. It can also be ran separately by just invoking python check.py. The script will perform a variety of automatic updates where possible, and provide a warning where auto-updates are not possible. The expecation is that all warnings are addressed before submitting for review, but given it is a new feature warnings do not block validation at this time. Here is a summary of the warnings and updates: Warnings: - Requirement missing required attributes - Invalid values for attributes - Invalid section header usage in any file - :keyword: and requirement mismatch Auto Updates: - Assigning :id: on new requirements where an ID missing - Adding :introduced: attribute on new requirements - Adding/correcting :updated: attribute on changed requirements Issue-ID: VNFRQTS-896 Signed-off-by: Lovett, Trevor Change-Id: I283441330a139aa1c6e2e79f0c54c5979bf44642 --- docs/Chapter5/Tosca/ONAP HPA Requirements.rst | 2 +- docs/Chapter5/Tosca/ONAP NFV Tosca.rst | 2 +- docs/Chapter5/Tosca/ONAP Tosca Overview.rst | 2 +- docs/Chapter5/Tosca/ONAP Tosca PNF Descriptor.rst | 16 ++++++++-------- docs/Chapter5/Tosca/ONAP VNF or PNF CSAR Package.rst | 4 ++-- 5 files changed, 13 insertions(+), 13 deletions(-) (limited to 'docs/Chapter5/Tosca') diff --git a/docs/Chapter5/Tosca/ONAP HPA Requirements.rst b/docs/Chapter5/Tosca/ONAP HPA Requirements.rst index d73bc6f..c99c3e2 100644 --- a/docs/Chapter5/Tosca/ONAP HPA Requirements.rst +++ b/docs/Chapter5/Tosca/ONAP HPA Requirements.rst @@ -14,7 +14,7 @@ HPA Requirements ------------------ +---------------- 1. SR-IOV Passthrought diff --git a/docs/Chapter5/Tosca/ONAP NFV Tosca.rst b/docs/Chapter5/Tosca/ONAP NFV Tosca.rst index 527b00f..93b6c3b 100644 --- a/docs/Chapter5/Tosca/ONAP NFV Tosca.rst +++ b/docs/Chapter5/Tosca/ONAP NFV Tosca.rst @@ -222,7 +222,7 @@ Definition Artifact -~~~~~~~~~~ +~~~~~~~~ Note: currently not supported. diff --git a/docs/Chapter5/Tosca/ONAP Tosca Overview.rst b/docs/Chapter5/Tosca/ONAP Tosca Overview.rst index 892e502..0603da6 100644 --- a/docs/Chapter5/Tosca/ONAP Tosca Overview.rst +++ b/docs/Chapter5/Tosca/ONAP Tosca Overview.rst @@ -70,7 +70,7 @@ protocol, which supports multiple TOSCA template yaml files, and also supports self-defined node or other extensions. TOSCA Introduction -^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^ TOSCA defines a Meta model for defining IT services. This Meta model defines both the structure of a service as well as how to manage it. A diff --git a/docs/Chapter5/Tosca/ONAP Tosca PNF Descriptor.rst b/docs/Chapter5/Tosca/ONAP Tosca PNF Descriptor.rst index ca5e677..8dadc3b 100644 --- a/docs/Chapter5/Tosca/ONAP Tosca PNF Descriptor.rst +++ b/docs/Chapter5/Tosca/ONAP Tosca PNF Descriptor.rst @@ -32,7 +32,7 @@ General Data Types -^^^^^^^^^^^^^^ +^^^^^^^^^^ .. req:: :id: R-484843 @@ -63,7 +63,7 @@ No artifact type is currently supported in ONAP. Capability Types -^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^ .. req:: :id: R-177937 @@ -78,11 +78,11 @@ Capability Types Requirements Types -^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^ Relationship Types -^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^ .. req:: :id: R-64064 @@ -97,13 +97,13 @@ Relationship Types Interface Types -^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^ No interface type is currently supported in ONAP. Node Types -^^^^^^^^^^^^^^ +^^^^^^^^^^ .. req:: :id: R-535009 @@ -123,13 +123,13 @@ Node Types Group Types -^^^^^^^^^^^^^^ +^^^^^^^^^^^ No group type is currently supported in ONAP. Policy Types -^^^^^^^^^^^^^^ +^^^^^^^^^^^^ .. req:: :id: R-596064 diff --git a/docs/Chapter5/Tosca/ONAP VNF or PNF CSAR Package.rst b/docs/Chapter5/Tosca/ONAP VNF or PNF CSAR Package.rst index c5172ad..eb7b3ba 100644 --- a/docs/Chapter5/Tosca/ONAP VNF or PNF CSAR Package.rst +++ b/docs/Chapter5/Tosca/ONAP VNF or PNF CSAR Package.rst @@ -14,7 +14,7 @@ VNF or PNF CSAR Package ------------------------- +----------------------- CSAR Overview ^^^^^^^^^^^^^ @@ -238,7 +238,7 @@ VNF or PNF Package Contents VNF or PNF Package Authenticity and Integrity -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ VNF or PNF CSAR package shall support a method for authenticity and integrity assurance. According to ETSI SOL004 the onboarding package shall be secured. -- cgit 1.2.3-korg