...

The intent of the VNF Requirement and Guidelines project is to inform VNF providers of the standards, specifications, and guidlines to which they should adhere when targeting the ONAP platform.  These requirements and guidelines will support the ONAP Architecture Principles, and ensure a consistent experience for VNF providers across the VNF lifecycle.  See the VNF Requirements Charter for more information.

...

• As VNF Requirements project is an ONAP project, all content must adhere to the general documentation standards defined in Creating Documentation section of the ONAP Developer Guide.
• All content must be written in reStructuredText (RST) with all warnings and errors resolved.
• Wherever possible, let RST handle numbering of content.  This includes ordered lists, section numbers, footnotes, etc.  This ensure content can be re-arranged easily with less likelihood of breaking numbering conventions.

Guideline Standards

TODOThe VNF and PNF Guidelines are the highest level guidance provided by the VNF Requirements project.  This section is best suited to include content that may provide context or forward-looking statements instead of concrete, verifiable requirements to which a VNF Provider should adhere.This text is strictly narrative in format, and does not include enumerated requirement and associated metadata as is the case in the VNF and PNF Requirements section of the document.

If a substantial change is to be proposed in this area of the requirements, then it should be initiated as a proposal with a corresponding JIRA ticket.  Refer to VNFRQTS How to Contribute for more details.

Requirement Standards

VNF Requirements are the foundation of the project and as such have the most stringent content standards.   The requirements form the basis of the specifications that a VNF provider must adhere to in order to successfully deploy and operate a VNF on the ONAP platform.  When considering the content for your requirement in the first place (incomplete or out of place). The goal of this section is to provide independent, enumerated, and generally verifable requirements for which a VNF should adhere to be managed on the ONAP platform and adhere to ONAP's architectural principles

This project makes use of an Sphinx extension called sphinxcontrib-needs to enable a number of useful features both internal to the project and enable sharing of structured data/information between projects.

...

Here is an example of a requirement after the conversion:

Requirement Example

These requirement definitions can be processed by the sphinxcontrib-needs extension and used in a variety of ways.

• Summary tables can be created via a needtable directive which provides a number of capabilities such as:
  • Export to a variety of formats such as CSV, Excel, and PDF
  • Filtering
  • Sorting
• All requirements can be exported as JSON file for consumption by other projects.
• By default metadata is hidden in the HTML document, but can easily be expanded to allow readers to learn more about the requirement.

...