Page tree
Skip to end of metadata
Go to start of metadata
Welcome to the OPNFVDOCS project page
Project description:
  • Support in producing documentation for OPNFV releases
  • Define guidelines and tooling for documentation handling across all OPNFV projects
  • Include any architecture diagrams or specifications, reference to OPNFV requirements list
  • Maintain the OPNFV documentation libraries 
How to work with documents in OPNFV please look at the Documentation guide
Release planning:
Euphrates release planning
Maintenance:
    • Set up a structure and templates for document development with source control (same as source code). Leveraging upstream documentation structure and tools.
    • Following as close as possible the same contribution process & tools as our source code
    • Develop initial set of release documents:
      • Installation Instruction 
      • Configuration & User Guide
      • Overview
      • Release Notes
    • Provide language guidance and document rendering options. All documents should be written in English. Available formatting for Colorado release is HTML and PDF format
    • Provide processes and tooling for OPNFV projects to implement and follow for consistency
Jira
Epics will be created for all overall documentation with attached sub-tasks assigned to all projects. Expected is a cross reference flow. Projects will handle user stories for documentation within their own backlogs but with a reference to user story in the OPNVFDOCS backlog. This is to facilitate follow up and to make the work visible for both parties.

Description of roles in the documentation project:
  • Committers (Editors): has overall responsibility of document structure, editing, style and toolchains
  • opnfvdocs contributors: individual section will have contributors who are domain experts in those areas, other contributors may simply help out working on the documentation and tools as needed.
  • other projects: Committers will be responsible for maintaining documentation artifacts in project repositories.

Bi weekly docs meeting,

https://wiki.opnfv.org/display/meetings

 

 

Key Project Facts

Project: OPNFV documentation project (opnfvdocs)
Project Creation Date: March 31, 2015
Project Category: Documentation
Lifecycle State: Incubation
Primary Contact: Sofia Wallin (sofia.wallin@ericsson.com)
Project Lead: Sofia Wallin (sofia.wallin@ericsson.com)
Jira Project Name: OPNFV documentation project
Jira Project Prefix: DOCS
Mailing list tag: [docs]
IRC: Server:freenode.net Channel:#opnfv
Repository: opnfvdocs

Committers:
christopher.price@ericsson.com
fatih.degirmenci@ericsson.com
Iben.Rodriguez@spirent.com
r-mibu@cq.jp.nec.com
sofia.wallin@ericsson.com

Link to TSC approval of the project: http://ircbot.wl.linuxfoundation.org/meetings/opnfv-meeting/2015/opnfv-meeting.2015-03-31-13.56.html
Link(s) to approval of additional committers:
* Approval of Victor Laza as a committer: http://lists.opnfv.org/pipermail/opnfv-tsc/2015-April/000747.html
* Approval of Ryota Mibu as a committer: http://lists.opnfv.org/pipermail/opnfv-tsc/2016-January/001777.html
* Approval of Sofia Wallin as a committer: http://lists.opnfv.org/pipermail/opnfv-tsc/2016-January/001778.html

Additional contributors

 

 

 

 

 

 

  • No labels