diff options
author | Lovett, Trevor <trevor.lovett@att.com> | 2020-07-02 11:19:00 -0500 |
---|---|---|
committer | Lovett, Trevor <trevor.lovett@att.com> | 2020-07-12 18:17:41 -0500 |
commit | d1f93f4febdd5b34e96b954dd11e635bc0ee8041 (patch) | |
tree | 899f326fa7ed5ecd05e8dcaf535e7c3ddd99d3e9 /docs/Chapter5/Tosca/ONAP Tosca PNF Descriptor.rst | |
parent | cbbd1db5dfe2035d56901575218380c32216da92 (diff) |
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 <trevor.lovett@att.com>
Change-Id: I283441330a139aa1c6e2e79f0c54c5979bf44642
Diffstat (limited to 'docs/Chapter5/Tosca/ONAP Tosca PNF Descriptor.rst')
-rw-r--r-- | docs/Chapter5/Tosca/ONAP Tosca PNF Descriptor.rst | 16 |
1 files changed, 8 insertions, 8 deletions
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 |