Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

TopicNotesFollow-up
Tool Chain
  1. Review OPNFV Documentation practices w/ Sofia Wallin
  2. Review Draft Comparison and Recommendation of Document Tool Chain
  • Require plain text content - IF it supported as input into Pandocs.  Markdown, ReStructured Text, etc.
  • Goal is "white label" content only
  • Will still require transformation tools to enable appropriate HTML output
  • Doc team will be required to produce native content for selected Doc types (see Contributor & Committer roles review below)


StructureTeam Roles
  • Review draft of latest structurerole definitions
  • Discuss Keys to Success

View file
nameONAP

Documentation Scope

Doc Flow 7-

07

11-2017.

xlsx

pptx
height250

 

Structure
  • Review draft of latest structure
Contributor & Committer roles
  • Review role definitions
  • Review assignments
  • View file
    nameONAP Doc Flow Documentation Scope 7-07-2017.pptxxlsx
    height250


     

Next Steps
  •  Regroup current Wiki Topics into simpler structure based on Audiences / Roles (e.g. Developer, User, Operations, etc.) Gregory Glover 
  •  Schedule special meeting with project team members on June 29 from 7-8 pm ET to review 1) draft structure and 2) Tool chain options Kenny Paul 
  •  Clarify what documentation needs to be formally captured and managed vs. use of the Wiki Gregory Glover 
  •  Create initial draft of Documentation Guidelines - Process Gregory Glover 
  •  Create initial draft of Documentation Guidelines - Style Guide Andrea Anderson  
  •  Create initial draft of Committer Checklist (e.g. Consistency, Style Guide, Grammar, etc.) Matthew Harffy, Gregory Glover  
  •  Identify a formal Documentation contact for each Project Gregory Glover  Create initial draft for M1 Deliverables Rich Bennett 30 Jun
  •  Try combining two sets of disparate content and combining them into a real world piece of master document (hiearchy) - e.g. Release Notes Spencer Seidel  Liu Yang
  •  Clarify role of Contributor and Committers by Doc type Gregory Glover 

...