/
2017-07-11 Doc Project Meeting

2017-07-11 Doc Project Meeting

Owned by gg2147@att.com
Last updated: Aug 07, 2018 by Rich Bennett
1 min read

Topics, Notes, and Follow-Up Tasks

Topic

Notes

Follow-up

Topic

Notes

Follow-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 @gg2147@att.com Jul 18, 2017
Create initial draft of Documentation Guidelines - Process @gg2147@att.com Jul 11, 2017
Create initial draft of Documentation Guidelines - Style Guide @Andrea Anderson Jul 11, 2017 
Create initial draft of Committer Checklist (e.g. Consistency, Style Guide, Grammar, etc.) @Matthew Harffy, @gg2147@att.com Jul 11, 2017 
Identify a formal Documentation contact for each Project @gg2147@att.com Jul 18, 2017
Try combining two sets of disparate content and combining them into a real world piece of master document (hiearchy) - e.g. Release Notes. Examples provided here An Example of Creating Documents with ReStructured Text-Sphinx-Readthedocs and A Sample about how to develop documents by Markdown @Spencer Seidel  @Liu YangJul 11, 2017
Clarify role of Contributor and Committers by Doc type @gg2147@att.com Jul 18, 2017