OPNFV documentation project
Produce documentation for OPNFV releases including but not limited to:
Include any architecture diagrams or specifications, reference to OPNFV requirements list.
Provide guidelines and tooling for documentation handling across all OPNFV projects
Current OPNFV documentation library
Set up a structure, and templates, for document development with source control (same as source code). Leveraging upstream documentation structure and tools.
Following as close as possible the same contribution process & tools as our source code
Structure OPNFV documentation logically
Develop initial set of release documents:
(A) Release note - should be mostly a template in opnfvdocs and read in from the different areas -release components, ISO toolchain contents, test coverage, links to other docs
(B) Config guide - should contain sections on: getting the software: centrally done in opnfvdocs, preparing your hardware: taken from pharos, installing the ISO: taken from each ISO directory, validating the install: taken from functest
(C) User Guide - overview of the platform: central overview of tools taken from each ISO directory. instruction on deploying to the platform: maybe taken from functest
Provide language options for documentation where applicable: In first release English only, Wiki (via HTML
scraping from Gerrit), and PDF.
Provide tooling and processes for OPNFV projects to implement and follow for consistency
Key Project Facts
Project: OPNFV documentation project (opnfvdocs)
Project Creation Date: March 31, 2015
Project Category: Documentation
Lifecycle State: Incubation
Primary Contact: Sofia Wallin (email@example.com)
Project Lead: Sofia Wallin (firstname.lastname@example.org)
Jira Project Name: OPNFV documentation project
Jira Project Prefix: DOCS
Mailing list tag: [docs]
IRC: Server:freenode.net Channel:#opnfv
Link to TSC approval of the project: http://ircbot.wl.linuxfoundation.org/meetings/opnfv-meeting/2015/opnfv-meeting.2015-03-31-13.56.html
Link(s) to approval of additional committers:
* Approval of Victor Laza as a committer: http://lists.opnfv.org/pipermail/opnfv-tsc/2015-April/000747.html
* Approval of Ryota Mibu as a committer: http://lists.opnfv.org/pipermail/opnfv-tsc/2016-January/001777.html
* Approval of Sofia Wallin as a committer: http://lists.opnfv.org/pipermail/opnfv-tsc/2016-January/001778.html
Description of roles in the documentation project:
Committers (Editors): has overall responsibility of document structure, editing, style and toolchains
opnfvdocs contributors: individual section will have contributors who are domain experts in those areas, other contributors may simply help out working on the documentation and tools as needed.
other projects: Committers will be responsible for maintaining documentation artifacts in project repositories.