Tool Chain Architecture ONAP Documentation Tool Chain Architecture
ONAP Documentation - Basic Flow Author Developers: Dev. Guidelines, Release Notes, APIs Doc Team: User Guide, All Other Configure Validate Chunk Map to ONAP structure Edit / Approve Edit per Style Guide Committers Approve per Checklist Store Store into repo(s) per ONAP structure Publish Generate HTML or other formats as required
ONAP Documentation - Tool Chain Options Author Any plain text (e.g. Markdown or ReSt) transformable via Pandocs or similar Configure Pandoc / Other? Edit / Approve Edit per Style Guide Approve per Checklist Store Sphinx Jekyll Publish ReadMeDocs GitHub Require only plain text transformable by Pandoc or similar tooling. Most developers used to Markdown or similar low level languages - counterproductive to try to enforce a single syntax? Transformation tooling will be required to validate, chunk and map content submitted by developers to the ONAP structure Basic “white label” output that: Satisfies ONAP structure Is consumable as desired by the ONAP community
ONAP Documentation Owners *No self-Committers CONTRIBUTOR COMMITTER Author Content Validate Content Transform to ONAP TOC Edit per Style Guide Store & Publish PROJECTS – Source Code Dev. Guides API’s Release Notes Project Developers Project Committers* Principal: Project Committers Secondary: Doc. Team Doc. Team PROJECTS – Supporting Doc Dependencies Issues Architecture Principal: Project SMEs Sec: ONAP Community DEVELOPER TOOLS & USER GUIDES Principal: Doc. Team Sec: Project SMEs Principal: Doc. Team* Sec: Project SMEs USE CASES & PLANNING Principal: TSC Sec: LF staff LF Staff* COMMUNITY Principal: LF Staff Sec: ONAP Community
ONAP Documentation Owners *No self-Committers CONTRIBUTOR COMMITTER Author Content Validate Content Transform to ONAP TOC Edit per Style Guide Store & Publish PROJECTS – Source Code Dev. Guides API’s Release Notes Project Developers Project Committers* Principal: Project Committers Secondary: Doc. Team Doc. Team PROJECTS – Supporting Doc Dependencies Issues Architecture Principal: Project SMEs Sec: ONAP Community DEVELOPER TOOLS & USER GUIDES Principal: Doc. Team Sec: Project SMEs Principal: Doc. Team* Sec: Project SMEs USE CASES & PLANNING Principal: TSC Sec: LF staff LF Staff* COMMUNITY Principal: LF Staff Sec: ONAP Community
ONAP Documentation Team – Committer Roles Technical Committers Tool Chain Selection & Maintenance Documentation Guidelines Committer Checklist Project Committers Insure the project owners author & update content, per release Assist with Markdown transformation when needed? Edit & Approve Store & Publish Developer & User Guide Committers Author and update content per release (via yourself or another contributor) Edit & Approve (no self-committers!)
ONAP Documentation Team – Insuring Success of ONAP! What brought you all here? How should we work together? How do we hold each other accountable? How should we best structure our team and our work?