Difference between revisions of "Documentation Contributor Guide"
(→Actions items) |
(→Adding new content) |
||
| (35 intermediate revisions by 4 users not shown) | |||
| Line 15: | Line 15: | ||
* 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. | * 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. | ||
| − | = | + | {| class="wikitable" |
| + | |- | ||
| + | ! 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 == | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | {| class="wikitable" | |
| + | |- | ||
| + | ! 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 || https://wiki.openstack.org/wiki/Documentation/SpecialityTeams || Olena Logvinova || https://review.openstack.org/#/c/267481 || Merged | ||
| + | |- | ||
| + | |} | ||
| − | == | + | == 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: [mailto:ogusarenko@mirantis.com Olga Gusarenko], [mailto:mzlatkova@mirantis.com Maria Zlatkova] and [mailto:ologvinova@mirantis.com Olena Logvinova]. |
| − | |||
| − | + | ---- | |
| − | + | [[Category:Documentation]] | |
| − | |||
Latest revision as of 08:25, 15 January 2016
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.
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.
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 | https://wiki.openstack.org/wiki/Documentation/SpecialityTeams | Olena Logvinova | https://review.openstack.org/#/c/267481 | Merged |
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.
