User Tools

Site Tools


documentation_projects

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
documentation_projects [2015/03/31 15:26]
Iben Rodriguez
documentation_projects [2015/10/22 02:46]
Iben Rodriguez
Line 3: Line 3:
  
   * [[documentation_projects:​OPNFV Documentation]]   * [[documentation_projects:​OPNFV Documentation]]
 +  * https://​wiki.opnfv.org/​documentation/​opnfvdocs <-- up to date project info page current from April 10th and updated from gerrit
 +  * 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
  
-==== Project List Summary ==== 
   - OPNFV – Open Platform for Network Function Virtualization   - OPNFV – Open Platform for Network Function Virtualization
 +
 +=== Release One Project List Summary ===
 +  - functest - Functional Testing - https://​wiki.opnfv.org/​opnfv_functional_testing
 +  - bgs - Bootstrap/​Get started (Genesis) - https://​wiki.opnfv.org/​get_started
 +  - pharos - Testbed infrastructure - https://​wiki.opnfv.org/​pharos
 +  - documentation - https://​wiki.opnfv.org/​documentation_projects/​opnfv_documentation ​
 +
 +=== Other Projects (not part of release 1) ===
   - Copper – Deployment Policy for VNF - https://​wiki.opnfv.org/​copper   - Copper – Deployment Policy for VNF - https://​wiki.opnfv.org/​copper
   - OSCAR - System Configuration And Reporting - https://​wiki.opnfv.org/​oscar/​project_proposal ​   - OSCAR - System Configuration And Reporting - https://​wiki.opnfv.org/​oscar/​project_proposal ​
-  - Functional Testing - https://​wiki.opnfv.org/​opnfv_functional_testing 
   - vSwitch testing - https://​wiki.opnfv.org/​characterize_vswitch_performance_for_telco_nfv_use_cases   - vSwitch testing - https://​wiki.opnfv.org/​characterize_vswitch_performance_for_telco_nfv_use_cases
   - Resource Management - https://​wiki.opnfv.org/​requirements_projects/​resource_management ​   - Resource Management - https://​wiki.opnfv.org/​requirements_projects/​resource_management ​
Line 18: Line 42:
   - Parser - https://​wiki.opnfv.org/​parser ​   - Parser - https://​wiki.opnfv.org/​parser ​
   - Octopus - Contiuous Integration - https://​wiki.opnfv.org/​continuous_integration_ci ​   - Octopus - Contiuous Integration - https://​wiki.opnfv.org/​continuous_integration_ci ​
-  - Documentation ​- https://​wiki.opnfv.org/​documentation_projects/opnfv_documentation  +  - 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) 
 +  - Yardstick ​- https://​wiki.opnfv.org/​yardstick 
 +  - QTIP - https://​wiki.opnfv.org/platform_performance_benchmarking 
 +  ​- ​
documentation_projects.txt · Last modified: 2015/12/10 15:07 by julien zhang