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

1 files changed, 8 insertions, 8 deletions

diff --git a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Suggested Naming Convention for Common Parameters.rst b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Suggested Naming Convention for Common Parameters.rst
index 416b1f0..b03bd53 100644
--- a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Suggested Naming Convention for Common Parameters.rst
+++ b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Suggested Naming Convention for Common Parameters.rst
@@ -3,14 +3,14 @@
 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 
 Suggested Naming Convention for Common Parameters
-----------------------------------------------------------------------------------------------------------
+-------------------------------------------------
 
 Many VNFs use the parameters in the table below are used in user_data.
 The table below provides a suggested naming convention for these common
 parameters.
 
 Netmask
-^^^^^^^^^^^^^^^^^^
+^^^^^^^
 
 .. csv-table:: **Table 8: Suggested Naming Convention for Common Parameters:  Netmask**
    :header: Parameter Name,Parameter Type,Notes
@@ -23,7 +23,7 @@ Netmask
    int_{network-role}_v6_subnet_<index>_netmask, string,
 
 CIDR
-^^^^^^^^^^^^^^^^^^
+^^^^
 
 .. csv-table:: **Table 9: Suggested Naming Convention for Common Parameters:  CIDR**
    :header: Parameter Name,Parameter Type,Notes
@@ -36,7 +36,7 @@ CIDR
    int_<network-role>_v6_subnet_<index>_cidr, string,
 
 Default Gateway
-^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^
 
 .. csv-table:: **Table 10: Suggested Naming Convention for Common Parameters:  Default Gateway**
    :header: Parameter Name,Parameter Type,Notes
@@ -47,7 +47,7 @@ Default Gateway
    {network-role}_v6_subnet_<index>_default_gateway, string,
 
 DCAE Collector IP Address
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. csv-table:: **Table 11: Suggested Naming Convention for Common Parameters:  DCAE Collector Address**
    :header: Parameter Name,Parameter Type,Notes
@@ -58,7 +58,7 @@ DCAE Collector IP Address
    dcae_collector_v6_ip_<index>, string,
 
 NTP Server IP Address
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^
 
 .. csv-table:: **Table 12: Suggested Naming Convention for Common Parameters:  NTP Server IP Address**
    :header: Parameter Name,Parameter Type,Notes
@@ -69,7 +69,7 @@ NTP Server IP Address
    ntp_v6_ip_<index>, string,
 
 DNS
-^^^^^^^^^^^^^^^^^^
+^^^
 
 .. csv-table:: **Table 13: Suggested Naming Convention for Common Parameters:  DCAE Collector Address**
    :header: Parameter Name,Parameter Type,Notes
@@ -80,7 +80,7 @@ DNS
    dns_{network-role}_v6_ip_<index>, string,
 
 Security Group
-^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^
 
 .. csv-table:: **Table 14: Suggested Naming Convention for Common Parameters:  Security Group**
    :header: Parameter Name,Parameter Type,Notes