Comparison for current
| Characteristic | Proposed for ONAP | Example from OPNFV | Current ONAP & Examples | Other Option or Examples |
|---|---|---|---|---|
| Documentation Source Repo Host | gerrit.onap.org | gerrit.openfv.org | All documentation is on the wiki.onap.org as pages or attached reference documents in PDF form. Wiki contains more than release documentation | also could be sourced by gerrit or other git tools Maybe we could create a onap.github.org |
| Documentation Source Repo Structure | /doc - Top level documentation index & /<any other project repo>/doc - documentation sub-directories of both of the above reflect the |
| Subset of the links on wiki.onap.org | Same |
| Source Format | Restructured Text | Top Level Index Page | Multiple Requiring Commercial Software | Markdown |
| Published Documentation | HTML, PDF, Epub for all documentation at onap.readthedocs.io/en/latest/ | HTML or PDF depending on the document or topic | HTML at github.org(no need to build) other documentation by jekyll. | |
| CI/CD Flow | Committer approved change merged to doc or other project/doc repository branch triggers a verify & build of published documentation. | Top level index reference to other project release notes and creation of a composite source document set | Manually updated for a release by collecting information from projects eg. Release Notes 1.0.0 draft | For Markdown. Committer approved change merged to doc or other project/doc repository branch, no building progres, the webpage will be refreshed in seconds For PDF or other form, same with RST. |
| CI/CD Tools | Gerrit, Jira, Tox, Jenkins, Sphinx | Gerrit,Jira, Jekyll. No need any CI tools, just use the github.org to gerenrate a webpage. |
Recommendation
TBP