...
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
...
Follow the described steps if you need to migrate DeveloperWiki content to ReadTheDocs:
Read the "DeveloperWiki and ReadTheDocs Usage Policy"
- To understand the reason behind this migration task and to know what DeveloperWiki content we are targeting it is essential to read and understand the TSC approved policy.
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 to the above policy.
Label the DeveloperWiki page(s) to show the "Migration to ReadTheDocs 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
Label 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 "DW" to the Confluence space "Deprecated".
- To archive the migrated/deprecated DeveloperWiki page, go to the top of page, open the page menu "[...]" and open the "Move" command. Move the page below "Migrated or Deprecated Documentation".
...