This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
documentation_projects:opnfv_documentation [2015/03/31 08:04] Christopher Price |
documentation_projects:opnfv_documentation [2016/02/26 04:31] (current) Ryota Mibu [Backlog] |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | NOTE: This is an old page not being maintained any more. This page was used for the initial project proposal. | ||
+ | |||
+ | This page will be removed after a few weeks (in May 2015). | ||
+ | |||
==== Project Name: ==== | ==== Project Name: ==== | ||
Line 10: | Line 14: | ||
* Installation guide | * Installation guide | ||
* User guide | * User guide | ||
+ | * Any relevant references and interface specifications for OPNFV projects or components. | ||
* Include any architecture diagrams or specifications, reference to OPNFV requirements list. | * Include any architecture diagrams or specifications, reference to OPNFV requirements list. | ||
* Provide guidelines and tooling for documentation handling across all OPNFV projects | * Provide guidelines and tooling for documentation handling across all OPNFV projects | ||
Line 24: | Line 29: | ||
* (D) API reference (if there is content in release 1) | * (D) API reference (if there is content in release 1) | ||
* (E) Interface specification (if there is content in release 1) | * (E) Interface specification (if there is content in release 1) | ||
- | * Provide language options for documentation where applicable: In first release English only, Wiki and PDF. | + | * 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 concistency | + | * Provide tooling and processes for OPNFV projects to implement and follow for consistency |
==== Dependencies: ==== | ==== Dependencies: ==== | ||
Line 35: | Line 40: | ||
==== Committers and Contributors: ==== | ==== Committers and Contributors: ==== | ||
- | * Name of and affiliation of the project leader : | + | {{scrape>https://gerrit.opnfv.org/gerrit/gitweb?p=opnfvdocs.git;a=blob_plain;f=INFO;}} |
- | * Christopher Price: christopher.price@ericsson.com | + | |
- | * Names and affiliations of the committers | + | |
- | * Christopher Price: christopher.price@ericsson.com | + | |
- | * Wenjing Chu (Dell): wenjing_chu@dell.com | + | |
- | * Ashiq Khan (NTTdocomo): khan@nttdocomo.com | + | |
- | * Fatih Degirmenci: fatih.degirmenci@ericsson.com | + | |
- | * Rodriguez, Iben: Iben.Rodriguez@spirent.com | + | |
- | * Malla Reddy Sama: sama@docomolab-euro.com | + | |
* Any other contributors | * Any other contributors | ||
* Bryan Sullivan (AT&T) | * Bryan Sullivan (AT&T) | ||
Line 50: | Line 48: | ||
Description of roles in the documentation project: | Description of roles in the documentation project: | ||
- | * Committers (Editors): has overall responsibility of document structure, editing, style | + | * 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. | * 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. | * other projects: Committers will be responsible for maintaining documentation artifacts in project repositories. | ||
Line 66: | Line 64: | ||
* By release 2 a multi-project toolchain will be in place with processes and version control | * By release 2 a multi-project toolchain will be in place with processes and version control | ||
* Iterative improvements to the processes and toolchains are expected on a release by release basis. | * Iterative improvements to the processes and toolchains are expected on a release by release basis. | ||
+ | |||
+ | ==== Backlog ==== | ||
+ | |||
+ | * https://etherpad.opnfv.org/p/opnfvdocs_b_release_issues | ||
+ | * update docu manual: [[http://artifacts.opnfv.org/opnfvdocs/docs/enable_docu_gen.html]] | ||
+ | |||