diff options
| author |   Gregory Glover <gg2147@att.com> | 2018-07-13 14:40:47 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@onap.org> | 2018-07-13 14:40:47 +0000 |
| commit | 7ea6653494f54b8df03be666b35876356d67a113 (patch) | |
| tree | 8666000343dc9dae501c01b9dcddd1a54ddf1c8e /docs/guides/onap-developer/how-to-use-docs/style-guide.rst | |
| parent | 0ac1717d523a5cef4aadcc7d912ae8a5f570f0bd (diff) | |
| parent | 0ec5a7558a6700a034552c95ccb616ddff6cbff1 (diff) | |
Merge "Add support for sphinx NEEDS Directive"
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs/style-guide.rst')
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/style-guide.rst | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/style-guide.rst b/docs/guides/onap-developer/how-to-use-docs/style-guide.rst index 74fc261c1..324688551 100644 --- a/docs/guides/onap-developer/how-to-use-docs/style-guide.rst +++ b/docs/guides/onap-developer/how-to-use-docs/style-guide.rst @@ -118,3 +118,27 @@ Tasks - Break down end-to-end tasks into manageable chunks. + +ONAP Conventions for the Use of Sphinx Directives +------------------------------------------------- + +Needs Directive +^^^^^^^^^^^^^^^ + + * Needs IDs must match the regular expression "^[A-Z0-9]+-[A-Z0-9]+" + + * The prefix (string before the dash) must be described in the following table + +.. list-table:: Needs Prefix Use + :align: center + :widths: 8 40 40 + :header-rows: 1 + + * - Prefix + - Description + - Use + + * - R + - Represents a requirement that must be met by a VNF provider + - Defined only in the vnfrqts project repositories, may be referenced in any project repository source + |