2017-07-11 Doc Project Meeting

Topics, Notes, and Follow-Up Tasks

Topic	Notes	Follow-up
Tool Chain	Review OPNFV Documentation practices w/ Sofia Wallin 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 18 Jul 2017 Create initial draft of Documentation Guidelines - Process gg2147@att.com 11 Jul 2017 Create initial draft of Documentation Guidelines - Style Guide Andrea Anderson 11 Jul 2017 Create initial draft of Committer Checklist (e.g. Consistency, Style Guide, Grammar, etc.) Matthew Harffy, gg2147@att.com 11 Jul 2017 Identify a formal Documentation contact for each Project gg2147@att.com 18 Jul 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 Yang11 Jul 2017 Clarify role of Contributor and Committers by Doc type gg2147@att.com 18 Jul 2017