Contributors:
Contributors may create all types of JIRA issues to add new User Stories, Tasks, etc. The general flow is to have EPICs and User stories in place first that create basic deliverable structure with any seed material inserted. Additional tasks can be created to generate material for missing sections. Once a document section has text, then Bug reports against that text would be more appropriate. The majority of the progress is thus expected to be via bug reports triggering fixes in the deliverables.
To Convert existing documentation to .rst
For the Project's seed documentation it is useful to convert from other document formats into .rst.
A video of the conversion process using Pandocs is available here.
To Build from .rst to .html
After making changes in your local clone of the repo, it is recommended to validate the appearance of the changes in .html.
A video demonstrating a local build of the .html is available here.
To Report a Bug
ONAP requires all bug fixes to be associated with a JIRA issue, so create the JIRA bug report first.
Issue Type:
Bug
Component Field:
This is the VNFRQTS Project deliverable impacted: VNF Guidelines, VNF Requirements etc.
Description field:
Please be as specific as you can in raising a bug report against the VNFRQTS deliverables. If there is a requirement number or document section number, please use that.
It helps to have a brief example use case illustrating the problem. If this bug impacts the Release A use cases, please indicate how that is impacted as well.
Linked Issues:
One Bug should cover one topic. If there are multiple issues raised, please use separate bug report and link them using the Linked Issues section.
To propose a Fix to a Bug
Start by creating a bug report, then propose the fix to the bug. ONAP requires all bug fixes to be associated with a JIRA issue.
You will need to check in/out your changes to the requirements documentation using git/gerrit. To use Git & Gerrit, ( assuming you do not already have them) will require you to set up your environment. You will need to clone the ONAP repos from http://gerrit.onap.org to your local machine to make your changes as a contributor. The ONAP community is tracking progress using the JIRA system. So please remember to create and close the jira tickets for the tasks you are completing so that the progress we make is visible. The workflow of the ONAP development process and policies are summarized in this figure.
Committers
ONAP uses the Gerrit review system for committing changes to the code - including our documentation source files. Please recall the ONAP policy is that committers cannot merge their own changes. The documentation project has a review checklist for general documentation.
VNFRQTS Project Sprints and Backlogs
The weekly VNFRQTS conference calls are used for scrum style grooming of the Product and Sprint backlogs. This is where prioritization of Bugs and other issues for resolution is discussed.