Documentation Projects
The following projects are related to development of documentation for the OPNFV reference platform.
-
-
This example shows how automated documentation updates are done with graphics:
exampledoc
Proposal:
We would build a /doc folder for each project that is part of release 1.
a documentation framework with readme, license, and other agreed files would be started for each project
as part of the ci pipeline we would automate building html, pdf and other agreed files from the documents
scraper links on opnfv wiki would be updated for each project to pull in content from the docs
training on the above would be performed with weekly session to be run by the team doing this work
adjustments would be made to track this
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:
each project will have working documentation as part of release 1
each project will have a known good working build process
OPNFV community members will have people to go to for help getting setup with the build tools
we have a trusted on boarding process for OPNFV members
we have experts already working with OpenStack networking to help us better integrate into the open source community
Release One Project List Summary
Other Projects (not part of release 1)
-
-
-
-
-
-
-
-
-
-
-
sfqm -Software Fastpath Service Quality Metrics project
promise - Resource Management
opendaylight - OpenDaylight-OPNFV interlock
availability - High Availability
vnfgraph - OpenStack Based VNF Forwarding
Graph - (vnf_forwarding_graph)
-
-