Wiki

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

• OPNFV Documentation

Here’s what I think we wanted – let’s adjust and get this going.

this page will show how automated documentation updates are done with graphics… exampledoc

Proposal:

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

1. OPNFV – Open Platform for Network Function Virtualization
2. Copper – Deployment Policy for VNF - https://wiki.opnfv.org/copper
3. OSCAR - System Configuration And Reporting - https://wiki.opnfv.org/oscar/project_proposal
4. Functional Testing - https://wiki.opnfv.org/opnfv_functional_testing
5. vSwitch testing - https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases
6. Resource Management - https://wiki.opnfv.org/requirements_projects/resource_management
7. Doctor (Fault Management and Maintenance) - https://wiki.opnfv.org/requirements_projects/doctor_fault_mangement_and_maintenance
8. High availability for VNFs - https://wiki.opnfv.org/requirements_projects/high_availability_for_vnfs
9. Telco KPI Monitoring - https://wiki.opnfv.org/collaborative_development_projects/opnfv_telco_kpi_monitoring
10. Rescuer - https://wiki.opnfv.org/collaborative_development_projects/rescuer
11. IPv6 - https://wiki.opnfv.org/ipv6-enabled_vanilla_opnfv
12. Parser - https://wiki.opnfv.org/parser
13. Octopus - Contiuous Integration - https://wiki.opnfv.org/continuous_integration_ci
14. Documentation - https://wiki.opnfv.org/documentation_projects/opnfv_documentation