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

Compare with Current View Page History

« Previous Version 11 Next »

DeveloperWiki and ReadTheDocs Usage Policy

The TSC 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 formal 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

For details on how to contribute to the formal ONAP documentation, refer to the ONAP Documentation Guide. 

Accordingly, already available "ONAP E2E and component documentation" in the Developer Wiki will be migrated to ReadTheDocs (in case the information is still valid).


Content to be evaluated

  • Architecture
  • Developing ONAP
  • Setting up ONAP
  • Integrating with ONAP
  • Supporting Tools

  plus all other active projects (priority not set yet)


Content currently under evaluation

  • to be defined


Already evaluated/migrated content


Related Jira Entries

DOC-590 - Getting issue details... STATUS

DOC-435 - Getting issue details... STATUS

DOC-443 - Getting issue details... STATUS

DOC-450 - Getting issue details... STATUS

DOC-506 - Getting issue details... STATUS

DOC-591 - Getting issue details... STATUS


The Process of Migration

Read the "DeveloperWiki and ReadTheDocs Usage Policy"

tbd

Identify formal ONAP documentation content in the DeveloperWiki

Identify formal ONAP documentation content in the DeveloperWiki which has to be migrated to ReadTheDocs in accordance with the above policy.

Mark the DeveloperWiki page(s) to show the "Migration in Progress"

tbd

Export DeveloperWiki page(s)

Check the used Confluence template/macro/format.

Manual/semi-automated task depending on the used Confluence macros which contain the content of the page.

See Doc Tools page for a description of available tools, capabilities and limitations.

Prepare Content for usage in ReadTheDocs

tbd

Release Content to the ONAP Master Branch

tbd

Mark the DeveloperWiki page(s) as "Migrated to ReadTheDocs"

tbd

Archive the DeveloperWiki page(s)

Migrated (or deprecated) content must be moved from the Confluence space "Developer Wiki" to the Confluence space "Deprecated". To do so, scroll to the top of the DeveloperWiki page, open the page menu "[...]" and open the "Move" command. Move the page below "Migrated or Deprecated Documentation". 


  • No labels