Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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. 

...