This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
documentation_projects [2014/11/06 11:47] Christopher Price |
documentation_projects [2015/12/10 15:07] (current) julien zhang |
||
|---|---|---|---|
| Line 2: | Line 2: | ||
| The following projects are related to development of documentation for the OPNFV reference platform. | The following projects are related to development of documentation for the OPNFV reference platform. | ||
| - | * [[requirements_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 | ||
| + | |||
| + | |||
| + | === 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 | ||
| + | - OSCAR - System Configuration And Reporting - https://wiki.opnfv.org/oscar/project_proposal | ||
| + | - vSwitch testing - https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases | ||
| + | - Resource Management - https://wiki.opnfv.org/requirements_projects/resource_management | ||
| + | - Doctor (Fault Management and Maintenance) - https://wiki.opnfv.org/requirements_projects/doctor_fault_mangement_and_maintenance | ||
| + | - High availability for VNFs - https://wiki.opnfv.org/requirements_projects/high_availability_for_vnfs | ||
| + | - Telco KPI Monitoring - https://wiki.opnfv.org/collaborative_development_projects/opnfv_telco_kpi_monitoring | ||
| + | - Rescuer - https://wiki.opnfv.org/collaborative_development_projects/rescuer | ||
| + | - IPv6 - https://wiki.opnfv.org/ipv6-enabled_vanilla_opnfv | ||
| + | - Parser - https://wiki.opnfv.org/parser | ||
| + | - Octopus - Contiuous Integration - https://wiki.opnfv.org/continuous_integration_ci | ||
| + | - 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 | ||