Difference between revisions of "Documentation/NewtonDeliverables"
(→Contributor Guide) |
Ogusarenko (talk | contribs) |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 16: | Line 16: | ||
==Contributor Guide== | ==Contributor Guide== | ||
| − | * UI/UX section improvement | + | * <s>UI/UX section improvement</s> http://docs.openstack.org/contributor-guide/user-guidelines.html |
| − | * Improve documentation of docs tools/theme etc | + | * Improve documentation of <s>docs tools</s>/theme etc http://docs.openstack.org/contributor-guide/doc-tools.html |
| − | * Add diagram recommendations | + | * <s>Add diagram recommendations</s> http://docs.openstack.org/contributor-guide/diagram-guidelines.html |
| − | * <s>Document new Install Guide process</s> | + | * <s>Document new Install Guide process</s> http://docs.openstack.org/contributor-guide/project-install-guide.html |
| − | * Process discussions: Who should follow this guide? Introduction of a minimal review time? Section about contribution recommendations: what devs should contribute, review expectations of docs, expected turn-around time, etc. How to deprecate/remove docs? Also define which are continuous-release, versioned, etc. | + | * <s>Process discussions: Who should follow this guide? Introduction of a minimal review time? Section about contribution recommendations: what devs should contribute, review expectations of docs, expected turn-around time, etc. How to deprecate/remove docs? Also define which are continuous-release, versioned, etc.</s> https://review.openstack.org/#/c/346575/ |
==Security Guide== | ==Security Guide== | ||
| Line 35: | Line 35: | ||
==User Guides== | ==User Guides== | ||
| − | * Work with the Ops Guide to check for duplicated content | + | * <s>Work with the Ops Guide to check for duplicated content</s> |
| − | * Check for missing content and out of date content - fix links | + | * <s>Check for missing content and out of date content - fix links</s> |
* Bring new service projects into the User Guides - esp. projects that have info in dev docs that could be moved into the user guide | * Bring new service projects into the User Guides - esp. projects that have info in dev docs that could be moved into the user guide | ||
| − | * IA plan - consistency, links, findability plus tables, code snippets, naming conventions (use contributor guide) | + | * <s>IA plan - consistency, links, findability plus tables, code snippets, naming conventions (use contributor guide)</s> |
==Docs Tools/Infra== | ==Docs Tools/Infra== | ||
| Line 45: | Line 45: | ||
* <s>Create cookiecutter template for project-specific install guides</s> | * <s>Create cookiecutter template for project-specific install guides</s> | ||
* Config option to mark documents as deprecated (assuming we will work out how to uniformly decide that) | * Config option to mark documents as deprecated (assuming we will work out how to uniformly decide that) | ||
| − | * | + | * Match guidelines for consistent RST file naming by renaming RST files from underbar to hyphen in openstack-manuals repository. |
| + | * Have Infra team get site off Cloud Sites, for HTTPS and the ability to delete properly. Spec: http://specs.openstack.org/openstack-infra/infra-specs/specs/doc-publishing.html | ||
Latest revision as of 13:12, 5 August 2016
Contents
Newton Docs Deliverables
Ops and Arch Guides
-
Review content of both guides, and delete anything out of date -
Review architecture of both guides, and possibly combine -
Move Ops Guide into openstack-manuals repo - Gather content from Ops internal documentation
HA Guide
-
Move HA Guide into openstack-manuals
Installation Tutorial
-
Project-specific Install Guides to be written/maintained by each project: https://review.openstack.org/#/c/301284/ -
Remainder of the work to be done on the existing Install Guide: https://review.openstack.org/#/c/310588 - New spec/poc for potentially automating test process in a future release
Contributor Guide
-
UI/UX section improvementhttp://docs.openstack.org/contributor-guide/user-guidelines.html - Improve documentation of
docs tools/theme etc http://docs.openstack.org/contributor-guide/doc-tools.html -
Add diagram recommendationshttp://docs.openstack.org/contributor-guide/diagram-guidelines.html -
Document new Install Guide processhttp://docs.openstack.org/contributor-guide/project-install-guide.html -
Process discussions: Who should follow this guide? Introduction of a minimal review time? Section about contribution recommendations: what devs should contribute, review expectations of docs, expected turn-around time, etc. How to deprecate/remove docs? Also define which are continuous-release, versioned, etc.https://review.openstack.org/#/c/346575/
Security Guide
-
Pull printed guide. - Updating neutron section
API Docs
- Migration to RST + YAML: sign up for a service on the wiki: https://wiki.openstack.org/wiki/Documentation/Migrate#API_Reference_Plan
-
Freeze api-site/api-ref - Add a redirect to new HTML pages
-
API site bug list cleanup: move specific service API ref bugs to project's Launchpad - Write tutorials!
- Work on "First Application with OpenStack" patches and updates.
User Guides
-
Work with the Ops Guide to check for duplicated content -
Check for missing content and out of date content - fix links - Bring new service projects into the User Guides - esp. projects that have info in dev docs that could be moved into the user guide
-
IA plan - consistency, links, findability plus tables, code snippets, naming conventions (use contributor guide)
Docs Tools/Infra
-
Docbook XML tool removal - OpenStackdocstheme work
-
Create cookiecutter template for project-specific install guides - Config option to mark documents as deprecated (assuming we will work out how to uniformly decide that)
- Match guidelines for consistent RST file naming by renaming RST files from underbar to hyphen in openstack-manuals repository.
- Have Infra team get site off Cloud Sites, for HTTPS and the ability to delete properly. Spec: http://specs.openstack.org/openstack-infra/infra-specs/specs/doc-publishing.html
