User Tools

Site Tools


Documentation Projects

The following projects are related to development of documentation for the OPNFV reference platform.


  1. We would build a /doc folder for each project that is part of release 1.
  2. a documentation framework with readme, license, and other agreed files would be started for each project
  3. as part of the ci pipeline we would automate building html, pdf and other agreed files from the documents
  4. scraper links on opnfv wiki would be updated for each project to pull in content from the docs
  5. training on the above would be performed with weekly session to be run by the team doing this work
  6. adjustments would be made to track this
  7. all work tracked in jira and to be performed using the OPNFV build process.

The idea would be to jumpstart the documentation parts of each OPNFV project using the build tools. This serves these goals:

  1. each project will have working documentation as part of release 1
  2. each project will have a known good working build process
  3. OPNFV community members will have people to go to for help getting setup with the build tools
  4. we have a trusted on boarding process for OPNFV members
  5. we have experts already working with OpenStack networking to help us better integrate into the open source community

Release One Project List Summary

  1. functest - Functional Testing -
  2. bgs - Bootstrap/Get started (Genesis) -
  3. pharos - Testbed infrastructure -

Other Projects (not part of release 1)

  1. Copper – Deployment Policy for VNF -
  2. OSCAR - System Configuration And Reporting -
  3. Octopus - Contiuous Integration -
  4. sfqm -Software Fastpath Service Quality Metrics project
  5. promise - Resource Management
  6. opendaylight - OpenDaylight-OPNFV interlock
  7. availability - High Availability
  8. vnfgraph - OpenStack Based VNF Forwarding
  9. Graph - (vnf_forwarding_graph)
documentation_projects.txt · Last modified: 2015/12/10 15:07 by julien zhang