Difference between revisions of "Documentation/ReorganizeUserGuides"
m (→The List of Tasks) |
m (→Cloud Admin Guide RST Conversion) |
||
| Line 28: | Line 28: | ||
== Cloud Admin Guide RST Conversion == | == Cloud Admin Guide RST Conversion == | ||
* One of the OpenStack Docs selected for Conversion after the Vancouver 2015 design summit is the Cloud Admin Guide. Converting the guide to RST is now a task and a priority of the User Guide Speciality team. | * One of the OpenStack Docs selected for Conversion after the Vancouver 2015 design summit is the Cloud Admin Guide. Converting the guide to RST is now a task and a priority of the User Guide Speciality team. | ||
| + | * When conversion is complete, we can reorganize the content of the Cloud Admin Guide, Admin User Guide, and End User Guide. | ||
== Additional Information == | == Additional Information == | ||
Revision as of 06:25, 3 June 2015
Contents
Reorganise the User Guide - Task List
Paired with the User Guide Specialty team page, this list of tasks to complete the project helps to keep track of changes to information architecture, consistency, and conventions in the guides.
Please add your name next to one of the tasks on the List of Tasks to prevent duplication of improvements detailed in the docs spec.
The List of Tasks
- Remove duplication in table of contents
- Several items repeat in the table of contents. Repairs to the RST files are needed. (DONE)
- Separate User Guides in separate directories while keeping a common directory to simplify setup and writing: (DONE)
- Develop the User Task Matrix
- Rework the abstract for each guide to clearly identify audience and purpose.
- Convert Cloud Administration Guide to RST
- Reduce duplication of content between the guides, pointing the Cloud Admin Guide to the Admin User Guide, and Admin User Guide to the End User Guide for readers to accomplish further tasks, which is a suitable step for the abstract rewrite
- Remove any unnecessary or self-explanatory procedures from the dashboard chapter
- Determine a good structure for how to present tasks - Dashboard, Command-line, or Config File edits
- Update the images (.jpg etc) of the dashboard for the Admin and Projects tabs
- Bring consistency to certain procedures within the guide. Some have tables, while some have variable lists:
- Create Network (normal variable list)
- Launch Instance (variable list in bold)
- Manage stacks and Access & Security (tables)
- Mange objects (bullets)
- Spacing between steps in procedures are inconsistent. Example: "Procedure To Copy an Object From One Container to Another" and
"Procedure: To Create a Metadata-only object without a file" in the "Manage and Object" section of the User Guide. - Joseph Robinson
Cloud Admin Guide RST Conversion
- One of the OpenStack Docs selected for Conversion after the Vancouver 2015 design summit is the Cloud Admin Guide. Converting the guide to RST is now a task and a priority of the User Guide Speciality team.
- When conversion is complete, we can reorganize the content of the Cloud Admin Guide, Admin User Guide, and End User Guide.
Additional Information
- Reorganize User Guides for Liberty Spec associated with the Reorganise User Guides Blueprint.
