...
- Describe the functionality to be provided by the project
- Curate/Edit/Organize Documentation - provided by committers and contributors to documentation project for each ONAP release including
- Identifying the documentation required for a release based on an end to end view of targeted user audiences, tasks requirements, use cases, input from ONAP committees (architecture, marketing, etc) and approved projects.
- Reviewing projects, release plans, and committee artifacts early in a release to align on end to end platform terminology and where draft documentation is provided in the release plan
- Creating/Maintaining a top level index for all documentation in an ONAP release (org.onap.doc repository).
- Creating/Maintaining sub-repositories below org.onap.doc/sources for projects and committees that provide documentation source material. Committer ACLs on sub-repositories may supplement or override the inherited org.onap.doc committer ACL to align control of the sub-repository with other projects providing the source material.
- Providing consistent style guides for contributors.
- Write Documentation - provided by contributors to this project or other sources
- Create documentation source material that references other project provided source material and adds information tailored to a particular user audience and task.
- Documentation CI/CD Tool Chain - committers and contributors to the doc project create and/or configure tools that automatically generate release documentation from all sources
- Gerrit, Jenkins job builder configured to build documentation any time a top level or lower in the doc repository hierarchy change. A successful build will trigger an update at Readthedocs.
- Gerrit, Jenkins job builder configured to build documentation any time a top level or lower in the doc repository hierarchy change. A successful build will trigger an update at Readthedocs.
- Curate/Edit/Organize Documentation - provided by committers and contributors to documentation project for each ONAP release including
- Specify any interface/API specifications proposed
- Sphinx and ReStructuredText will be used for index structure and source document contents.
- TBD other tools for auto generated or documentation embedded in source code (Swagger, Javadocs, etc.)
...
- Primary Contact Person: Greg Glover, Rich Bennett
- Names, gerrit IDs, and company affiliations of the committers
- Rich Bennett, rb2745@att.com, AT&T
- Nicholas Hu, jh245g@att.com, AT&T
- Timo Perala, timo.perala@nokia.com, Nokia
- Greg Glover, gg2147@att.com, AT&T
- Kevin Scaggs, ks0567@att.com, AT&T
- Steven Wright, sw3588@att.com, AT&T
- James Yang, james.yangliu@huawei.com, Huawei
- Andrei Kojukhov, andreik@amdocs.com, Amdocs
- Andrea Anderson, andrea.anderson@amdocs.com, Amdocs
- Matthew Harffy, matthew.harffy@amdocs.com, Amdocs
- Shasha Guo, guoshasha@chinamobile.com, China Mobile
- Ying Li, liyingyjy@chinamobile.com, China Mobile
- Lili Kong, konglili@chinamobile.com, China Mobile
- Names and affiliations of any other contributors
- TBD based on final requirements for Release 1
- Project Roles (include RACI chart, if applicable).
Other Information:
- Seed Code / Documentation -
- API Guides - MSO, AAI, APPC, Policy, Portal,
- Schema - AAI
- Guidelines - ONAP Logging
- See also the related project proposal on VNF Requirements etc.
- User Guides -
- Developer APPC
- Service Designer - Design, Deploy, SDC
- Administrator - ONAP Portal for administrators
- Operations - Operate, VID, Policy application, DMaaP Bus Controller, ONAP Portal for users
- Tutorials - Installing and Running the ONAP Demos, Automatically Creating a Netconf Mount in APPC from SDNC
- To Be Identified - Documents from VF-C, VNF SDK, Common TOSCA, Multi-VIM, other?
- Vendor Neutral Yes
- Meets Board policy (including IPR) Yes
...