.. This work is licensed under a Creative Commons Attribution 3.0 Unported License. http://creativecommons.org/licenses/by/3.0/legalcode ============================================== Documentation Contributor Guide reorganization ============================================== https://blueprints.launchpad.net/openstack-manuals/+spec/contributor-guide-reorg To facilitate more documentation contributions, we should keep the contributor guide as readable as possible. Problem description =================== The Documentation Contributor Guide contains various useful contents for the docs contributors. Since we have added content gradually, however, the guide has become scattered. Proposed change =============== 1. Sort current contents by task group. 2. Clarify the tasks to contribute docs. 3. Reorganize and add the contents by tasks. Alternatives ------------ Keep the current guide as is. Implementation ============== Assignee(s) ----------- * Olga Gusarenko * KATO Tomoyuki Work Items ---------- * Sort current contents by task group. * Clarify the tasks to contribute docs. * Reorganize and add the contents by tasks. * Refine the contents for first timers. * Refine the contents for docs readers, such as bug reporting. * Refine the contents to build docs. * Refine the contents to write docs. * Refine the contents to review docs. * Refine the contents to contribute API docs. * Refine the contents to contribute installation guides. * Refine the contents to contribute UI/UX docs. * Refine the contents about team. Dependencies ============ None. Testing ======= None. References ========== * http://docs.openstack.org/contributor-guide/ * https://etherpad.openstack.org/p/austin-docs-contributorguide