Requirement ID Generation and RST Validation 87/109987/2
authorLovett, Trevor <trevor.lovett@att.com>
Thu, 2 Jul 2020 16:19:00 +0000 (11:19 -0500)
committerLovett, Trevor <trevor.lovett@att.com>
Sun, 12 Jul 2020 23:17:41 +0000 (18:17 -0500)
commitd1f93f4febdd5b34e96b954dd11e635bc0ee8041
tree899f326fa7ed5ecd05e8dcaf535e7c3ddd99d3e9
parentcbbd1db5dfe2035d56901575218380c32216da92
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
51 files changed:
check.py [new file with mode: 0644]
docs/Chapter4/Devops.rst
docs/Chapter4/Modularity.rst
docs/Chapter4/Resiliency.rst
docs/Chapter4/Security.rst
docs/Chapter5/Heat/General Guidelines for Heat.rst
docs/Chapter5/Heat/ONAP Heat Cinder Volumes.rst
docs/Chapter5/Heat/ONAP Heat High Availability.rst
docs/Chapter5/Heat/ONAP Heat Networking.rst
docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst
docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst
docs/Chapter5/Heat/ONAP Heat Post Orchestration & VNF Configuration.rst
docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Contrail Resource Parameters.rst
docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters.rst
docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters.rst
docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters.rst
docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/ONAP Output Parameter Names.rst
docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs.rst
docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource Property.rst
docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Suggested Naming Convention for Common Parameters.rst
docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}.rst
docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{vm-type}.rst
docs/Chapter5/Heat/ONAP Heat Support of Environment Files.rst
docs/Chapter5/Heat/ONAP Heat Template Constructs.rst
docs/Chapter5/Heat/ONAP Heat VNF Modularity.rst
docs/Chapter5/Tosca/ONAP HPA Requirements.rst
docs/Chapter5/Tosca/ONAP NFV Tosca.rst
docs/Chapter5/Tosca/ONAP Tosca Overview.rst
docs/Chapter5/Tosca/ONAP Tosca PNF Descriptor.rst
docs/Chapter5/Tosca/ONAP VNF or PNF CSAR Package.rst
docs/Chapter7/Configuration-Management.rst
docs/Chapter7/Monitoring-And-Management.rst
docs/Chapter7/PNF-Plug-and-Play.rst
docs/Chapter7/VNF-On-boarding-and-package-management.rst
docs/Chapter8/Ansible-JSON-Key-Value-Description.rst
docs/Chapter8/Ansible-Playbook-Examples.rst
docs/Chapter8/Chef-JSON-Key-Value-Description.rst
docs/Chapter8/TOSCA-model.rst
docs/Chapter8/VES_Registration_3_2.rst
docs/Chapter8/VNF-License-Information-Guidelines.rst
docs/Chapter8/ves7_1spec.rst
docs/Chapter8/ves_5_4_1/VESEventListener.rst
docs/Chapter8/ves_7_2/ves_event_listener_7_2.rst
docs/changes-by-section-casablanca.rst
docs/changes-by-section-dublin.rst
docs/changes-by-section-el-alto.rst
docs/changes-by-section-frankfurt.rst
docs/conf.py
fix_invalid_metadata.py [deleted file]
release-requirement-changes.rst.jinja2
tox.ini