You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Topics, Notes, and Follow-Up Tasks

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)


Team Roles
  • Review role definitions
  • Discuss Keys to Success


Structure
  • Review draft of latest structure


  •  

Next Steps
  • 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 
  • 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 



  • No labels