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/Chapter4/Modularity.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/Chapter4/Modularity.rst')
| -rw-r--r-- | docs/Chapter4/Modularity.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/Chapter4/Modularity.rst b/docs/Chapter4/Modularity.rst index 5493276..7360cdb 100644 --- a/docs/Chapter4/Modularity.rst +++ b/docs/Chapter4/Modularity.rst @@ -73,7 +73,7 @@ This overview is provided to set the stage and help clarify the concepts that will be introduced. ONAP VNF Modularity -^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^ ONAP supports a modular Heat Orchestration Template design pattern, referred to as *VNF Modularity.* With this approach, a single VNF may be @@ -137,7 +137,7 @@ template must correspond 1:1 with a base template or add-on module template. Suggested Patterns for Modular VNFs -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ There are numerous variations of VNF modularity. Below are two suggested usage patterns. @@ -180,7 +180,7 @@ which might be appropriate for smaller VNFs that do not have any scaling options. Modularity Rules -^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^ There are some rules to follow when building modular VNF templates: |