User Tools

Site Tools


documentation_projects:opnfv_documentation

This is an old revision of the document!


Project Name:

  • Proposed name for the project: opnfv documentation
  • Proposed name for the repository: opnfvdocs
  • Project Categories: Documentation

Project description:

  • Produce documentation for OPNFV releases including but not limited to:
    • Release notes
    • Installation guide
    • User guide
  • Include any architecture diagrams or specifications, reference to OPNFV requirements list.

Scope:

  1. 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.
  2. Same source contribution process like source code
  3. Write an introduction note to prospective contributors
  4. Structure OPNFV documentation logically
  5. Develop initial set of documents:
  6. (A) Release note
  7. (B) Install guide
  8. (C) User Guide
  9. (D) API reference (if there is content in release 1)
  10. (E) Interface specification (if there is content in release 1)
  11. 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.
  • Describe how the project is extensible in future

Dependencies:

  • All OPNFV projects participating in a release.
  • Upstream project documentation to be referenced
  • Are there any external fora or standard development organization dependencies. If possible, list and informative and normative reference specifications.

Committers and Contributors:

  • Name of and affiliation of the project leader :
    • 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
  • Any other contributors
    • Your name here!!!

Description of roles in the documentation project:

  • Committers (Editors): has overall responsibility of document structure, editing, style
  • 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 reviewers: review language/syntax/styling, general text quality

Planned deliverables

  • Project release documentation for OPNFV
  • If project deliverables have multiple dependencies across other project categories, described linkage of the deliverables.

Proposed Release Schedule:

  • opnfvdocs will follow each OPNFV release and produce needed documentation
documentation_projects/opnfv_documentation.1425911200.txt.gz · Last modified: 2015/03/09 14:26 by Christopher Price