Table of Contents
| Table of Contents |
|---|
Overview
The goal of the VNF Guidelines and Requirements project is to provide guidance to VNF providers on the guidelines, rules, and specifications to which a VNF must adhere to correctly onboard and operate within ONAP. These rules span across the VNF's lifecycle and are influenced by the various components that comprise ONAP as well as various industry standards that are required for interoperability.
...
| Contribution Type | Method(s) |
|---|---|
| General questions, feedback, or support requests | Leverage the ONAP mailing lists. Send an email to onap-discuss@lists.onap.org and use the project hashtag #vnfrqts in the subject line of your email. |
| Staying apprised of progress or collaborating on new work | Attend the weekly VNF Requirements project meetings. Review prior meeting minutes Additionally you can register for a Linux Foundation ID, and sign into Gerrit and/or JIRA to repository commits and JIRA issues.
|
| Submitting Bugs | If you find an issue in the VNF Requirements project in either the ONAP Developer Guide or the ONAP Wiki, please submit a JIRA ticket under the VNF Requirements project Project: VNF Requirements Issue Type: Bug Please include the link to the page in question and if applicable the requirement(s) IDs that are impacted. |
| Contributing Updates to VNF Provider Guidelines and Requirements | We welcome both new requirements and revisions to existing requirements and content. Before contributing the content, please familiarize yourself with the VNFRQTS Requirement and Documentation Standards. Our preferred form of contribution is to submit changes as Gerrit Reviews against the target VNF Requirements repository (see Submitting Gerritt Reviews for more details) If you are proposing substantial changes to the project or the change requires discussion, then we encourage you to create a Proposal on the ONAP VNF Requirements Project Wiki to introduce the topic first. Please refer to the VNF Requirements Proposals page for more details. If you do not feel comfortable with the tool chain required to submit changes directly to the reStructuredText via Gerrit reviews, then we would still like to support your contributions and encourage you to put the details of your changes into JIRA. Project: VNF Requirements Issue Type: Task Summary: Short summary of the change In the Description field please include the following details:
If you are submitting a ticket, then you are encouraged to attend the VNF Requirements weekly meeting if your schedule permits. |
...
- Before submitting a change, open a JIRA ticket to introduce the change.
- Project: VNF Requirements
- Issue Type: Story for changes that can be incorporated via a single change, Epic if the updates will require multiple commits. If you need an Epic, then you will need a story for each set of changes you wish to make. If the changes you are proposing are substantial, then you may need to create an entry in VNF Requirements Proposals for discussion before proceeding with your requirement changes.
- Summary: Descriptive summary of the changes to be made
- Fix Version: Target ONAP release for your changes
- Clone the appropriate repository for your content (see VNFRQTS Requirement and Documentation Standards for guidance and links).
- Navigate to the directory you cloned the repository into
Run the following command to generate the documentation and verify everything works properly
Code Block language bash title build docs <project-dir> tox -e docs
- If everything works properly, this will generate the HTML documentation in the
docs\_build\htmldirectory
...