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

Compare with Current View Page History

« Previous Version 52 Next »

TABLE OF CONTENTS


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 "formal ONAP E2E and component documentation" in the Developer Wiki will be migrated to ReadTheDocs (in case the information is still valid).


DeveloperWiki Content

Some outlook and history for migrations.

To be evaluated

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

  plus all other active projects (priority not set yet)

Currently under evaluation

  • none

Already evaluated/migrated

Archived in the Confluence space Deprecated under Migrated or Deprecated Documentation:

Unable to render {children}. Page not found: Deprecated:Migrated or Deprecated Documentation.


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

! WORK IN PROGRESS !

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.
  • Ensure that the content is valid for the latest release of ONAP. Update documentation accordingly.

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

  • tbd

Update the Migration Tracking Information

Export DeveloperWiki page(s)

  • Depending on the used Confluence macros (which contains the content of the page) the export will be a manual or semi-automated task.
  • See Doc Tools page for a description of available tools, capabilities and limitations.

Prepare Content for usage in ReadTheDocs

  • tbd 

Contribute to the ONAP Master Branch

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 "Developer Wiki" to the Confluence space "Deprecated".
  • To archive the migrated/deprecated DeveloperWiki page, go to the top of page, open the page menu "[...]" on the right side and choose the "Move" command. Move the page below "Migrated or Deprecated Documentation". 

Update the Migration Tracking Information

  • Remove the provided migration information on this page. Edit the section "DeveloperWiki Content - Currently under evaluation".
  • Information at "DeveloperWiki Content - Already evaluated/migrated" is updated automatically after you have archived the migrated DeveloperWiki page(s).
  • Close the Jira ticket


  • No labels