Jump to: navigation, search

Difference between revisions of "Documentation Contributor Guide"

(Reworking and moving content from Wiki)
Line 62: Line 62:
 
* Where: Google Hangouts
 
* Where: Google Hangouts
 
* Whom to contact to participate: [mailto:ogusarenko@mirantis.com Olga Gusarenko], [mailto:mzlatkova@mirantis.com Maria Zlatkova] and [mailto:ologvinova@mirantis.com Olena Logvinova].
 
* Whom to contact to participate: [mailto:ogusarenko@mirantis.com Olga Gusarenko], [mailto:mzlatkova@mirantis.com Maria Zlatkova] and [mailto:ologvinova@mirantis.com Olena Logvinova].
 
 
== Meetings agenda ==
 
 
'''September, 3 2015''':
 
* Welcoming new team member - Svetlana Karsliouglu, Launchpad Id: skarslioglu
 
* Task allocation among the team (see the table above): to commit the changes by the next meeting
 
* Discussing the new content to be added to the guide in the nearest future: Punctuation, Titles (how to write section, topics, figure, table titles), and Lists (how to use lists in the documentation, punctuation in lists, etc.)
 
 
 
'''August, 20 2015''':
 
* Different formatting practices discussion, finding the best solution for each section in progress.
 
 
 
'''August, 13 2015''':
 
* Assigning pages to the team members.
 
* Deciding on how to preserve consistency of the rst guide with the wiki content
 
 
 
'''August, 4 2015''':
 
* Wiki page creation - we need to create a separate wiki page to store all the project related information:
 
** team info;
 
** table of contents with the links to the wiki-related content and an assignee for each section;
 
** meetings details (agenda, action items, etc.);
 
** details of committing (commit message, etc.).
 
 
* Separate directory in the openstack-manuals repo - сreate and adjust a separate directory in openstack-manuals for the guide.
 
 
== Actions items ==
 
 
'''August, 20 2015''':
 
* [https://wiki.openstack.org/wiki/Documentation/Conventions Documentation/Conventions] and [https://wiki.openstack.org/wiki/Documentation/Markup_conventions Documentation/Markup_Conventions]
 
**Status: in progress
 
 
 
'''August, 13 2015''':
 
* Rework the [https://wiki.openstack.org/wiki/Documentation/Conventions Documentation/Conventions] page
 
** Assignees: Olena Logvinova for the [https://wiki.openstack.org/wiki/Documentation/Conventions#Writing_style Writing style] section, Maria Zlatkova for the [https://wiki.openstack.org/wiki/Documentation/Conventions#Terms_and_usage Terms and usage] section
 
** Status: In progress
 
 
* Rework the [https://wiki.openstack.org/wiki/Documentation/Markup_conventions Documentation/Markup_Conventions] page
 
** Assignee: Olga Gusarenko
 
** Status: In progress
 
 
* Update the Documentation Contributor Guide page on how to keep the wiki and rst guide content consistent
 
** Assignee: Olga Gusarenko
 
** Status: Done
 
 
 
 
'''August, 4 2015''':
 
* Wiki page creation
 
** Assignee: Olena Logvinova
 
** Status: done
 
 
* Separate directory in the openstack-manuals repo
 
** Assignee: Olga Gusarenko
 
** Status: done (https://review.openstack.org/#/c/209377)
 
  
 
----
 
----
 
[[Category:Documentation]]
 
[[Category:Documentation]]

Revision as of 13:21, 23 October 2015

About the Documentation Contributor Guide team

Considering the contributors' experience and feedback, we are willing to improve and restructure the Documentation/Conventions page in order to create a full, and neatly organized guide that answers questions that arise in the docs creation workflow.

Quick links

Housekeeping

  • Use [Contributor Guide] in the subject line of your commits
  • While committing a new patch, always add 'Implements: blueprint docs-contributor-guide' to your commit messages. This way, a link to the patch will be automatically added to the blueprint.

Reworking and moving content from Wiki

Sign up for a chapter in the below table, then create a patch in RST in openstack-manuals/doc/contributor-guide/source/ for others to review.

Add the note about the status of a wiki page content relocation to the page you are working on at the moment, so that in case the wiki content is changed, the same changes are made to the rst files.

Wiki page Link Assignee Gerrit link Status
HowTo https://wiki.openstack.org/wiki/Documentation/HowTo Olena Logvinova Maria Zlatkova https://review.openstack.org/#/c/237089/ https://review.openstack.org/#/c/234320/ https://review.openstack.org/#/c/235488/1 https://review.openstack.org/#/c/233183/ https://review.openstack.org/#/c/234279/1 https://review.openstack.org/#/c/237534/ https://review.openstack.org/#/c/238483/ merged
HowTo/FirstTimers https://wiki.openstack.org/wiki/Documentation/HowTo/FirstTimers Olga Gusarenko https://review.openstack.org/#/c/227191/ merged
Documentation/Builds https://wiki.openstack.org/wiki/Documentation/Builds Olena Logvinova https://review.openstack.org/#/c/225651/ merged
Documentation/ContentSpecs https://wiki.openstack.org/wiki/Documentation/ContentSpecs Maria Zlatkova https://review.openstack.org/#/c/225110/ merged
Documentation/Conventions https://wiki.openstack.org/wiki/Documentation/Conventions Svetlana Karslioglu https://review.openstack.org/#/c/220389/ merged
Documentation/Markup_Conventions https://wiki.openstack.org/wiki/Documentation/Markup_conventions Olga Gusarenko: RST formatting and DockBook conventions https://review.openstack.org/#/c/215660/ https://review.openstack.org/#/c/218799/ https://review.openstack.org/#/c/232966/ https://review.openstack.org/#/c/238438 merged
Documentation/JSON_Conventions https://wiki.openstack.org/wiki/Documentation/JSON_conventions Olena Logvinova https://review.openstack.org/#/c/228359 merged
Documentation/Structure https://wiki.openstack.org/wiki/Documentation/Structure Olga Gusarenko https://review.openstack.org/#/c/220494 merged

Adding new content

Topic title Comments Assignee Gerrit link Status
Licencing and copyrighting an outline with links to http://www.openstack.org/brand/ https://review.openstack.org/static/cla.html and https://wiki.openstack.org/wiki/How_To_Contribute#Contributors_License_Agreement
Screenshots and topologies conventions
Team structure

Meetings

  • When: weekly on Thursdays at 14:00 UTC (Fridays 12:00am Australian Eastern Standard Time or GMT+10, Wednesday 7:00am Pacific Standard Time)
  • Where: Google Hangouts
  • Whom to contact to participate: Olga Gusarenko, Maria Zlatkova and Olena Logvinova.