You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Comparison

CharacteristicProposed for ONAPExample from OPNFVCurrent ONAP & ExamplesOther Option or Examples
Documentation Source Repo Hostgerrit.onap.orggerrit.openfv.orgAll documentation is on the
wiki.onap.org as pages or
attached reference documents
in PDF form.  Wiki contains more
than release documentation
Documentation Source Repo Structure

/doc - Top level documentation index &
          select cross project content

/<any other project repo>/doc - documentation
           source created/maintained by a project
           that is integrated into the top level
           index and documentation for  release

sub-directories of both of the above reflect the
          documentation index hierarchy

Top Level


Example of one "other project"




Top level structure (sub-directories) include
templates, release, development, testing. 

Example other project provides (in sub-directories)
material for integration into "release" and "development"

Subset of the links on wiki.onap.org
eg. Using ONAP



Source FormatRestructured TextTop Level Index PageMultiple Requiring Commercial Software
Published DocumentationHTML, PDF, Epub for all documentation at
onap.readthedocs.io/en/latest/

http://opnfv.readthedocs.io/en/latest/

HTML or PDF depending on the
document or topic
CI/CD FlowCommitter 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
CI/CD ToolsGerrit, Jira, Tox, Jenkins, Sphinx


Recommendation

TBP

  • No labels