This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
documentation_projects [2014/10/24 19:41] Wenjing Chu created |
documentation_projects [2015/12/10 15:07] julien zhang |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ==== Project Name: ==== | + | ==== Documentation Projects ==== |
+ | The following projects are related to development of documentation for the OPNFV reference platform. | ||
- | * Proposed name for the project: ''opnfv documentation'' | + | * [[documentation_projects:OPNFV Documentation]] |
- | * Proposed name for the repository: ''repo-name'' | + | * https://wiki.opnfv.org/documentation/opnfvdocs <-- up to date project info page current from April 10th and updated from gerrit |
- | * Project Categories: ''(Documentation, Requirements, Integration & Testing, Collaborative Development)'' | + | * This example shows how automated documentation updates are done with graphics: [[exampledoc]] |
- | * | + | |
- | ==== Project description: ==== | + | |
- | * Provide high level description of intended project and OPNFV use case and benefit, if needed. | + | |
- | * Include any architecture diagrams or specifications, reference to OPNFV requirements list. | + | |
- | ==== Scope: ==== | + | 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. | ||
- | - Set up a structure, and a template, for document development with source control (same as source code). We may take the main input from Openstack documentation structure and tools, and also consult odl. | + | The idea would be to jumpstart the documentation parts of each OPNFV project using the build tools. This serves these goals: |
- | - Same source contribution process like source code | + | - each project will have working documentation as part of release 1 |
- | - Write an introduction note to prospective contributors | + | - each project will have a known good working build process |
- | - Structure OPNFV documentation logically | + | - OPNFV community members will have people to go to for help getting setup with the build tools |
- | - Develop initial set of documents: | + | - we have a trusted on boarding process for OPNFV members |
- | - (A) Getting started guide to OPNFV for platform developers (i.e. developers in NFVI platform) | + | - we have experts already working with OpenStack networking to help us better integrate into the open source community |
- | - (B) Getting started guide to OPNFV for application developers / users (i.e. developers of higher layer VNF or MANO, and users who stay above the NFVI northbound interface) | + | |
- | - (C) Release note | + | |
- | - (D) API reference (if there is content in release 1) | + | |
- | - (E) Interface specification (if there is content in release 1) | + | |
- | - Operations guide (probably only in future releases) | + | |
- | - In first release: English only, Wiki and PDF. | + | |
- | * Describe the problem being solved by project | ||
- | * Specify any interface/API specification proposed, | ||
- | * Specify testing and integration: | ||
- | * Debugging and Tracing | ||
- | * Unit/Integration Test plans | ||
- | * Client tools developed for status shows etc. | ||
- | * Identity a list of features and functionality will be developed. | ||
- | * Identify what is in or out of scope. So during the development phase, it helps reduce discussion. | ||
- | * Describe how the project is extensible in future | ||
- | ==== Testability: ''(optional, Project Categories: Integration & Testing)'' ==== | + | === Release One Project List Summary === |
- | + | - functest - Functional Testing - https://wiki.opnfv.org/opnfv_functional_testing | |
- | * Specify testing and integration like interoperability, scalability, high availablity | + | - bgs - Bootstrap/Get started (Genesis) - https://wiki.opnfv.org/get_started |
- | * What QA and test resources will be available? | + | - pharos - Testbed infrastructure - https://wiki.opnfv.org/pharos |
- | + | - documentation - https://wiki.opnfv.org/documentation_projects/opnfv_documentation | |
- | ==== Documentation: ''(optional, Project Categories: Documention)'' ==== | + | |
- | + | ||
- | * API Docs | + | |
- | * Functional block description | + | |
- | + | ||
- | ==== Dependencies: ==== | + | |
- | + | ||
- | * Identify similar projects is underway or being proposed in OPNFV or upstream project | + | |
- | * Identify any open source upstream projects and release timeline. | + | |
- | * Identify any specific development be staged with respect to the upstream project and releases. | + | |
- | * Are there any external fora or standard development organization dependencies. If possible, list and informative and normative reference specifications. | + | |
- | * If project is an integration and test, identify hardware dependency. | + | |
- | + | ||
- | ==== Committers and Contributors: ==== | + | |
- | + | ||
- | * Name of and affiliation of the maintainer : Wenjing Chu (Dell), Ashiq Khna (NTTdocomo) | + | |
- | --- //[[wenjing_chu@dell.com|Wenjing Chu]] 2014/10/24 19:40// | + | |
- | * Names and affiliations of the committers | + | |
- | * Any other contributors | + | |
- | + | ||
- | Here are some potential roles in this project: | + | |
- | + | ||
- | * Editors: has overall responsibility of completing the document, structure, editing, style | + | |
- | * Content contributors: individual section will have contributors who are domain experts in those areas | + | |
- | * Validators: developers who follow the “guides” and validate correctness of the content, and contribute fixes/notes/additions etc. | + | |
- | * Other reviewers: review language/syntax/styling, general text quality | + | |
- | + | ||
- | ==== Planned deliverables ==== | + | |
- | + | ||
- | * Described the project release package as OPNFV or open source upstream projects. | + | |
- | * If project deliverables have multiple dependencies across other project categories, described linkage of the deliverables. | + | |
- | + | ||
- | ==== Proposed Release Schedule: ==== | + | |
- | + | ||
- | * When is the first release planned? | + | |
- | * Will this align with the current release cadence | + | |
+ | === 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 |