ONAP Documentation Guideline for the usage of Wiki

Problems to solve • ONAP Documentation is distributed over Wiki and RTD • Wiki

Proposal (Content) • Wiki: • ONAP release, project, subcommitee and development related content, e.

Proposal (Content) • Read. The. Docs: • All ONAP E 2 E and component

Proposal (Process) • All projects/subcommittees have to start using RTD for their documentation from

Slides: 5

Download presentation

ONAP - Documentation Guideline for the usage of Wiki and Read. The. Docs January 23 rd, 2020 ONAP Documentation Project

Problems to solve • ONAP Documentation is distributed over Wiki and RTD • Wiki Content is • Partly outdated, incomplete, … • Not Release specific • Not marked, if moved to RTD • See also: https: //wiki. onap. org/display/DW/ONAP+Documentation+Challenges+and+Proposals -> This causes confusion and frustration for ONAP Users. . . • Proposal: • Clear guideline for ONAP Projects/Subcommitees for the usage of Wiki and RTD 2

Proposal (Content) • Wiki: • ONAP release, project, subcommitee and development related content, e. g. • project management (meetings, plans, milestones, members, . . . ) • project specific development guides (to be discussed) • ongoing activities and discussions • ONAP community event documentation 3

Proposal (Content) • Read. The. Docs: • All ONAP E 2 E and component documentation • ONAP overview, architecture, API • ONAP developer guides (e. g. Documentation guide) • ONAP user guides (E 2 E) • ONAP component guides, release notes • ONAP administration/operations guides • ONAP use-case description and usage • ONAP tutorials • ONAP release notes 4

Proposal (Process) • All projects/subcommittees have to start using RTD for their documentation from the start • • • Plan and specify the delivered documents (as part of M 1) Document as you code in your project’s docs directory ! DOC Project offers support for Documentation handling Check and update existing documents in each release (according to the release process) Support E 2 E documentation (Check, update, review, …) • Ensure ownership for Wiki and RTD docs content • For RTD in line with the “submodule” removal and creation of new git repositories (e. g. for Architecture) • For Wiki a “task force” initiated by DOC project to analyze content • Existing Wiki content has to be migrated • Mark identified Wiki-pages with a status header (Example) Status – Reviewed, To. Be. Migrated, To. Be. Archived Date, Ownership, Link to RTD • Add/Migrate content to RTD, if required • Archive Wiki-Content, which is outdated or migrated • Migration tool and Wiki Header template will be provided by the DOC team 5