User Tools

Site Tools


This is an old revision of the document!

Project Name:

  • Proposed name for the project: opnfv documentation
  • Proposed name for the repository: repo-name
  • Project Categories: (Documentation, Requirements, Integration & Testing, Collaborative Development)

Project description:

  • Provide high level description of intended project and OPNFV use case and benefit, if needed.
  • Include any architecture diagrams or specifications, reference to OPNFV requirements list.


  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) Getting started guide to OPNFV for platform developers (i.e. developers in NFVI platform)
  7. (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)
  8. (C) Release note
  9. (D) API reference (if there is content in release 1)
  10. (E) Interface specification (if there is content in release 1)
  11. Operations guide (probably only in future releases)
  12. 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


  • Identify similar projects is underway or being proposed in OPNFV or upstream project
  • Identify any open source upstream projects and release timeline.
  • Identify any specific development be staged with respect to the upstream project and releases.
  • 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:

  • Name of and affiliation of the maintainer : Wenjing Chu (Dell), Ashiq Khna (NTTdocomo)

Wenjing Chu 2014/10/24 19:40

  • Names and affiliations of the committers
  • Any other contributors

Here are some potential roles in this project:

  • Editors: has overall responsibility of completing the document, structure, editing, style
  • Content contributors: individual section will have contributors who are domain experts in those areas
  • Validators: developers who follow the “guides” and validate correctness of the content, and contribute fixes/notes/additions etc.
  • Other reviewers: review language/syntax/styling, general text quality

Planned deliverables

  • Described the project release package as OPNFV or open source upstream projects.
  • If project deliverables have multiple dependencies across other project categories, described linkage of the deliverables.

Proposed Release Schedule:

  • When is the first release planned?
  • Will this align with the current release cadence
documentation_projects.1414179703.txt.gz · Last modified: 2014/10/24 19:41 by Wenjing Chu