Documentation Contributor Guide
Contents
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
- Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/docs-contributor-guide
- Specification: http://specs.openstack.org/openstack/docs-specs/specs/liberty/docs-contributor-guide.html
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.
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.
Add the note about the status of a wiki page content relocation to the page you are working on at the momemnt, 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 | |||
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 | Olena Logvinova: Writing style; Maria Zlatkova: Terms and Usage | in progress | |
Documentation/Markup_Conventions | https://wiki.openstack.org/wiki/Documentation/Markup_conventions | Olga Gusarenko | in progress | |
Documentation/JSON_Conventions | https://wiki.openstack.org/wiki/Documentation/JSON_conventions | |||
Documentation/Structure | https://wiki.openstack.org/wiki/Documentation/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.
Meetings agenda
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, 13 2015:
- Rework the Documentation/Conventions page
- Assignees: Olena Logvinova for the Writing style section, Maria Zlatkova for the Terms and usage section
- Status: In progress
- Rework the 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)