...
DRAFT for Review
Project Name:
- Proposed name for the project:
Documentation - Proposed name for the repository:
org.onap.docs
Project description:.
- Create and maintain documentation targeted to ONAP user audiences and the tasks they perform. For example:
- a platform developer pulling, building, running, hacking and pushing source code;
- an administrator installing, configuring, and monitoring an ONAP instance;
- a designer or tester creating, validating, and delivering service models;
- a VNF developer designing, testing, and certifying a VNF for use on ONAP
- a Service Provider using VNF Requirements as prototype text for RFPs to acquire VNFs to run in an ONAP context
- ... others as required for release plans or ONAP committees
- Establish and maintain a tool chain that supports the integration of documentation source material from all ONAP projects and builds documentation artifacts for each release.
- Establish a process to recognize source and final documentation dependencies in the release plan, end to end tests, and/or CI/CD to insure these deliverables are created early in a release cycle and remain current with changes made in other projects.
- Identify technical writers for each release to create and integrate content based on overall release requirements.
- Benefits include users quickly understand how to do required tasks, documentation is efficiently created and is in sync with the software in a release.
...
- Describe the functionality to be provided by the project.
- Documentation artifacts for ONAP integrating dependencies on source material from all projectsrelease that contain
- original content created by the documentation project and
- integrate source material from any project that the documentation depends to be consistent with an ONAP release.
- CI/CD Documentation Tool Chain
- The tool chain to develop the documentation artifacts is expected to be similar to the tool chain used to develop the code artifacts.
- There may be linkages within the tool chains - e.g. to propagate changes in APIs into the documentation.
- Documentation artifacts for ONAP integrating dependencies on source material from all projectsrelease that contain
- Please provide the full intended scope of the project; not just what is intended for the project's first release.
- First release establishes best practices and basic documentationpattern for managed documentation as well as the documentation for ONAP release 1.
- Subsequent releases will be required for all projects to comply with practices, complete content for all audiences, address how documents might be tailored or translated for use in different ONAP instances, etc.
- Identity a list of features and functionality will be developed.
- Documentation managed with the same pattern as source code including gerrit, jenkins, artifacts published in nexus or readthedocs.org, etc.
- output documentation format TBD - likely wiki and .pdf versions required with hyperlinks between the different documents as appropriate..
- depending on the volume of documentation, some indexing/ search capabilities may be required.
- Identify what is in or out of scope. During the development phase, it helps reduce discussion.
- TBD
- TBD
...
- JIRA project name: Documentation
- JIRA project prefix: DOC
Repo names:
docs
docs/tools
docs/source/admin
docs/source/design
docs/source/test
docs/source/platformdev
docs/source/vnfdev
docs/source/serviceprovider
Lifecycle State: proposal
Primary Contact:
Project Lead:
mailing list tag [docs]
Committers:
rb2745@att.com
timo.perala@nokia.com
gg2147@att.com
ks0567@att.com
james.yangliu@huawei.com
*Link to TSC approval:
Link to approval of additional submitters: