OpenStack Documentation Contributor Guide

Registered by Olga Gusarenko

We need to create OpenStack Documentation Contributor Guide based on the information located on wiki (conventions mainly).

Blueprint information

Status:
Complete
Approver:
Lana
Priority:
Low
Drafter:
Olga Gusarenko
Direction:
Approved
Assignee:
Olga Gusarenko
Definition:
Approved
Series goal:
Accepted for liberty
Implementation:
Implemented
Milestone target:
milestone icon liberty
Started by
Lana
Completed by
Lana

Related branches

Sprints

Whiteboard

Gerrit topic: https://review.openstack.org/#q,topic:bp/docs-contributor-guide,n,z

Addressed by: https://review.openstack.org/209074
    [Contributor Guide]

Addressed by: https://review.openstack.org/209377
    [Contributor Guide] contributor-guide git directory

Gerrit topic: https://review.openstack.org/#q,topic:rst_conv,n,z

Addressed by: https://review.openstack.org/215660
    [Contributor Guide] RST section, partial

Gerrit topic: https://review.openstack.org/#q,topic:CG_rst_refs,n,z

Addressed by: https://review.openstack.org/218799
    [Contributor Guide] RST references

Addressed by: https://review.openstack.org/220389
    Added a section about the writing style

Addressed by: https://review.openstack.org/220494
    [Contributor Guide] Documentation structure

Addressed by: https://review.openstack.org/223287
    Added a section about topic-based authoring

Addressed by: https://review.openstack.org/225110
    [Contributor Guide] Content Specs to RST

Addressed by: https://review.openstack.org/#/c/225651
    [Contributor Guide] Content Docs builds to RST

Addressed by: https://review.openstack.org/227191
    [Contributor Guide] Quickstart for the first timers

Addressed by: https://review.openstack.org/228359
    [Contributor Guide] Conversion JSON to RST

Addressed by: https://review.openstack.org/230994
    [Contributor Guide] Documentation bugs

Addressed by: https://review.openstack.org/231996
    [Contributor Guide] Reviewing documentation

Addressed by: https://review.openstack.org/233183
    [Contributor Guide] Tools and content overview

Addressed by: https://review.openstack.org/234279
    [Contributor Guide] Workflow diagram

Addressed by: https://review.openstack.org/234320
    [Contributor Guide] Build locally section to RST

Gerrit topic: https://review.openstack.org/#q,topic:bp/s,n,z

Addressed by: https://review.openstack.org/235488
    [Contributor Guide] Blueprints and specifications

Addressed by: https://review.openstack.org/237534
    [Contributor Guide] Cherry pick a change

Addressed by: https://review.openstack.org/#/c/237089/
    [Contributor Guide] Editor options section translation to RST

Addressed by: https://review.openstack.org/238470
    [Contributor Guide] Add glossary

Addressed by: https://review.openstack.org/238483
    [Contrib Guide] Backport section to RST & final edits

Gerrit topic: https://review.openstack.org/#q,topic:CG_alive,n,z

Addressed by: https://review.openstack.org/238915
    [Contributor Guide] Publishing

Addressed by: https://review.openstack.org/267481
    [contributor guide] Team structure section

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.