Jump to: navigation, search

Documentation Contributor Guide

Revision as of 10:55, 5 August 2015 by Olena Logvinova (talk | contribs) (Created page with "== About the Documentation Contributor Guide team == Considering the contributors' experience and feedback, we are willing to improve and restructure the Documentation/Conv...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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.

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.


Meetings agenda

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, 4 2015:

  • Wiki page creation
    • Assignee: Olena Logvinova
    • Status: done
  • Rework and move 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.
Wiki page Link Assignee Name Gerrit patch link Status
HowTo https://wiki.openstack.org/wiki/Documentation/HowTo
HowTo/FirstTimers https://wiki.openstack.org/wiki/Documentation/HowTo/FirstTimers
Documentation/Builds https://wiki.openstack.org/wiki/Documentation/Builds
Documentation/ContentSpecs https://wiki.openstack.org/wiki/Documentation/ContentSpecs
Documentation/Conventions https://wiki.openstack.org/wiki/Documentation/Conventions
Documentation/Markup_Conventions https://wiki.openstack.org/wiki/Documentation/Markup_conventions
Documentation/JSON_Conventions https://wiki.openstack.org/wiki/Documentation/JSON_conventions
Documentation/Structure https://wiki.openstack.org/wiki/Documentation/Structure