This project generates documentation (not code) for use by other ONAP projects and for publication by ONAP.
VNFRQTS Project in relation to Documentation Project
The documentation project compiles and publishes the final version of the documentation source material produced by this project.
The basic process to compile the documents at ONAP is to use the Sphinx / ReadThe Docs tool driven by a Jenkins job to pull the latest files from the repos and generate the output document format. The Documentation project will maintain the Sphinx/ Jenkins configs to generate the documents and have them hosted at onap.readthedocs.io. The VNF RQTS project is mainly responsible for generating the files in the VNF RQTS repos. Sphinx can accept documents in either reStructuredTexT (.rst) or Markdown (.md, .markdown, .txt, .text) formats. An example with ReStructuredTxT and corresponding html generated by Sphinx is provided by the documentation project. An example of developing and contribution markdown source documents is also available here.
Essentially, we ONAP will treat the requirements documentation as code. To compile the complete documents, The documentation project will maintain a Jenkins job that:
...