Versions Compared

Key

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

Developer Wiki and ReadTheDocs Usage Policy

The TCS Vote (2020, Feb. 19) approved the folowing Wiki/RTD usage policy:

DEVELOPER WIKI: for ONAP release, project, subcommitee and development related content, e.g.

  • project management (meetings, plans, milestones, members, ...)
  • project specific development guides
  • ongoing activities and discussions
  • ONAP community event documentation

READ THE DOCS: for all ONAP E2E and component documentation, e.g.

  • ONAP overview, architecture, API
  • ONAP developer guides (e.g. Documentation guide)
  • ONAP user guides (E2E)
  • ONAP component guides, release notes
  • ONAP administration/operations guides
  • ONAP use-case description and usage
  • ONAP tutorials
  • ONAP release notes

Already available "ONAP E2E and component documentation" in the Developer Wiki will be moved to ReadTheDocs and deleted (or at least labelled) in the Developer Wiki.

Guidelines / Best Practices

...