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/changes-by-section-el-alto.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/changes-by-section-el-alto.rst')
-rw-r--r-- | docs/changes-by-section-el-alto.rst | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/docs/changes-by-section-el-alto.rst b/docs/changes-by-section-el-alto.rst index a088598..4112047 100644 --- a/docs/changes-by-section-el-alto.rst +++ b/docs/changes-by-section-el-alto.rst @@ -14,7 +14,7 @@ Requirement Changes Introduced in El Alto -======================================================== +----------------------------------------- This document summarizes the requirement changes by section that were introduced between the Dublin release and @@ -25,7 +25,7 @@ navigate to the :depth: 2 Summary of Changes ------------------- +^^^^^^^^^^^^^^^^^^ * **Requirements Added:** 9 * **Requirements Changed:** 21 @@ -33,7 +33,7 @@ Summary of Changes Monitoring & Management > Data Structure Specification of the Event Record --------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -75,7 +75,7 @@ Requirements Changed Monitoring & Management > Monitoring & Management Requirements > Security -------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -151,7 +151,7 @@ Requirements Changed ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > resources > properties --------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -181,7 +181,7 @@ Requirements Changed ONAP Heat Orchestration Templates Overview > ONAP Heat Orchestration Template Filenames > Base Modules ------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -211,7 +211,7 @@ Requirements Changed ONAP Heat Orchestration Templates Overview > ONAP Heat Orchestration Template Filenames > Cinder Volume Modules ---------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -234,7 +234,7 @@ Requirements Changed ONAP Heat Orchestration Templates Overview > ONAP Heat Orchestration Template Filenames > Incremental Modules -------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -251,7 +251,7 @@ Requirements Changed ONAP Heat Orchestration Templates Overview > ONAP Heat Orchestration Template Filenames > Nested Heat file ----------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -268,7 +268,7 @@ Requirements Changed ONAP Heat VNF Modularity ------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -349,7 +349,7 @@ Requirements Added PNF Plug and Play > PNF Plug and Play -------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -378,7 +378,7 @@ Requirements Removed Resource: OS::Nova::Server - Parameters ---------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -409,7 +409,7 @@ Requirements Changed Resource: OS::Nova::Server - Parameters > Property: availability_zone ---------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -455,7 +455,7 @@ Requirements Changed VNF On-boarding and package management > Resource Control Loop --------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -472,7 +472,7 @@ Requirements Changed VNF On-boarding and package management > Resource Description -------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -488,7 +488,7 @@ Requirements Changed VNF Security > VNF Cryptography Requirements --------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -504,7 +504,7 @@ Requirements Changed VNF Security > VNF General Security Requirements ------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -530,7 +530,7 @@ Requirements Changed VNF Security > VNF Identity and Access Management Requirements --------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Removed @@ -547,7 +547,7 @@ Requirements Removed VNF Security > VNF Security Analytics Requirements --------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Removed @@ -565,7 +565,7 @@ Requirements Removed VNF or PNF CSAR Package > VNF Package Contents ----------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -583,7 +583,7 @@ Requirements Changed VNF or PNF CSAR Package > VNF or PNF Package Authenticity and Integrity ------------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed |