2017-07-18 Doc Project Meeting

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

Topics, Notes, and Follow-Up Tasks

Topic

Notes

Follow-up

Topic

Notes

Follow-up

How to Collaborate

  • Current priority work items  ....   JIRA Stories?,   other?

  • Asynchronous discussion or Q&A ....  onap-discuss tagged with doc?   wiki questions?,  other?

  • Real-time Q&A....    IRC onap-doc? ... not needed?

We will use JIRA for work items. DOC board here 

Rich will create a wiki questions topic and we will use this for Async @Rich BennettJul 18, 2017

No need for IRC

Create JIRA topicDOC-26: Webinar for Projects providing source documentationClosed  @Rich BennettJul 18, 2017 

Tool Chain

  1. Review Tool Chain recommendation:  @Rich Bennett; @Spencer Seidel; @Liu Yang

  2. Discuss next steps for implementation by August 3 (scope freeze for all projects)

Is there a way to convert doc docx to rst @Spencer Seidel Jul 18, 2017 
Merge example to doc

Contributor & Committer Guidelines

  1.  Review latest draft(s) of guidelines @Matthew Harffy; @Andrea Anderson

  2. Discuss next steps for implementation by August 3 (scope freeze for all projects)

Provide comments on draft

Master Structure

  • Review latest draft as time permits @Rich Bennett; All

  • Document any issues / changes needed

Add a matrix of projects and who is covering Doc Project Liaisons.  @Rich BennettJul 18, 2017
Add your names to projects that you can cover All  Jul 25, 2017 

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
Finalize Tool Chain @Rich Bennett; @Spencer Seidel; @Liu Yang Jul 25, 2017 
Finalize Contributor guidelines & Committer checklist @Matthew Harffy; @Andrea Anderson Aug 1, 2017