documentation_projects:opnfv_documentation
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
|
documentation_projects:opnfv_documentation [2015/03/03 15:00] Christopher Price |
documentation_projects:opnfv_documentation [2016/02/26 04:30] Ryota Mibu |
||
|---|---|---|---|
| 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 6: | Line 10: | ||
| ==== Project description: ==== | ==== Project description: ==== | ||
| - | * Provide high level description of intended project and OPNFV use case and benefit, if needed. | + | * Produce documentation for OPNFV releases including but not limited to: |
| + | * Release notes | ||
| + | * Installation 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 | ||
| ==== Scope: ==== | ==== Scope: ==== | ||
| - | - Set up a structure, and a template, for document development with source control (same as source code). We may take the main input from Openstack documentation structure and tools, and also consult odl. | + | * Set up a structure, and a template, for document development with source control (same as source code). Leveraging upstream documentation structure and tools. |
| - | - Same source contribution process like source code | + | * Following as close as possible the same contribution process & tools as our source code |
| - | - Write an introduction note to prospective contributors | + | * Structure OPNFV documentation logically |
| - | - Structure OPNFV documentation logically | + | * Develop initial set of release documents: |
| - | - Develop initial set of documents: | + | * (A) Release note |
| - | - (A) Getting started guide to OPNFV for platform developers (i.e. developers in NFVI platform) | + | * (B) Install guide |
| - | - (B) Getting started guide to OPNFV for application developers / users (i.e. developers of higher layer VNF or MANO, and users who stay above the NFVI northbound interface) | + | * (C) User Guide |
| - | - (C) Release note | + | * (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 (via HTML scraping from Gerrit), and PDF. |
| - | - Operations guide (probably only in future releases) | + | * Provide tooling and processes for OPNFV projects to implement and follow for consistency |
| - | - In first release: English only, Wiki and PDF. | + | |
| - | + | ||
| - | * Describe the problem being solved by project | + | |
| - | * Specify any interface/API specification proposed, | + | |
| - | * Specify testing and integration: | + | |
| - | * Debugging and Tracing | + | |
| - | * Unit/Integration Test plans | + | |
| - | * Client tools developed for status shows etc. | + | |
| - | * Identity a list of features and functionality will be developed. | + | |
| - | * Identify what is in or out of scope. So during the development phase, it helps reduce discussion. | + | |
| - | * Describe how the project is extensible in future | + | |
| - | + | ||
| - | ==== Testability: ''(optional, Project Categories: Integration & Testing)'' ==== | + | |
| - | + | ||
| - | * Specify testing and integration like interoperability, scalability, high availablity | + | |
| - | * What QA and test resources will be available? | + | |
| - | + | ||
| - | ==== Documentation: ''(optional, Project Categories: Documention)'' ==== | + | |
| - | + | ||
| - | * API Docs | + | |
| - | * Functional block description | + | |
| ==== Dependencies: ==== | ==== Dependencies: ==== | ||
| - | * Identify similar projects is underway or being proposed in OPNFV or upstream project | + | * All OPNFV projects participating in a release. |
| - | * Identify any open source upstream projects and release timeline. | + | * Upstream project documentation to be referenced |
| - | * Identify any specific development be staged with respect to the upstream project and releases. | + | * Where there are external fora or standard development organization dependencies, list informative and normative references & specifications. |
| - | * Are there any external fora or standard development organization dependencies. If possible, list and informative and normative reference specifications. | + | |
| - | * If project is an integration and test, identify hardware dependency. | + | |
| ==== 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;}} |
| - | * Wenjing Chu (Dell): wenjing_chu@dell.com | + | |
| - | * Names and affiliations of the committers | + | |
| - | * Ashiq Khna (NTTdocomo) | + | |
| - | * Chris Price | + | |
| * Any other contributors | * Any other contributors | ||
| + | * Bryan Sullivan (AT&T) | ||
| + | * Trevor Cooper: trevor.cooper@intel.com | ||
| - | Here are some potential roles in this project: | + | Description of roles in the documentation project: |
| - | * Editors: has overall responsibility of completing the document, structure, editing, style | + | * Committers (Editors): has overall responsibility of document structure, editing, style and toolchains |
| - | * Content contributors: individual section will have contributors who are domain experts in those areas | + | * 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. |
| - | * Validators: developers who follow the “guides” and validate correctness of the content, and contribute fixes/notes/additions etc. | + | * other projects: Committers will be responsible for maintaining documentation artifacts in project repositories. |
| - | * Other reviewers: review language/syntax/styling, general text quality | + | |
| ==== Planned deliverables ==== | ==== Planned deliverables ==== | ||
| - | * Described the project release package as OPNFV or open source upstream projects. | + | * Project release documentation for OPNFV |
| - | * If project deliverables have multiple dependencies across other project categories, described linkage of the deliverables. | + | * Including collation of all release relevant project documentations |
| + | * Establishment and maintenance of the OPNFV documentation processes and toolchains | ||
| ==== Proposed Release Schedule: ==== | ==== Proposed Release Schedule: ==== | ||
| - | * When is the first release planned? | + | * opnfvdocs will follow each OPNFV release and produce needed documentation |
| - | * Will this align with the current release cadence | + | * Release 1 will provide basic documentation including revision 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. | ||
| + | |||
| + | ==== Backlog ==== | ||
| + | |||
| + | * https://etherpad.opnfv.org/p/opnfvdocs_b_release_issues | ||
| + | |||
| + | |||
| + | ---- | ||
| + | |||
| + | |||
| + | {{scrape>http://artifacts.opnfv.org/opnfvdocs/docs/enable_docu_gen.html}} | ||
| + | |||
documentation_projects/opnfv_documentation.txt · Last modified: 2016/02/26 04:31 by Ryota Mibu
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: Creative Commons Attribution 4.0 International License
