Difference between revisions of "User Guides"

Revision as of 05:47, 12 November 2015

Welcome to the home page for the User Guide Specialty Team!

About the User Guide team

This team is all about the users.

Its purpose is to give us a space to have conversations about enterprise content, support companies who reuse upstream content from the guides, and also get some focus on information architecture, consistency, and conventions in the guides. Our scope covers long term changes, when new services appear in the OpenStack big tent community.

We focus on maintaining:

Cloud Admin Guide
End User Guide
Admin User Guide

For the Install Guide and the Networking Guide, see those respective speciality groups.

Quick links

User Guide Team Meeting information Instructions
Blueprint for reference and implementation Blueprints

Housekeeping

Use [User Guides] in the subject line of emails to the openstack-doc mailing list.
Keep track of tasks with the User Guide Task List.
First Blueprint (complete) User Guide Blueprints.
Second Blueprint (ongoing) M User Guide Blueprints.

Meetings

Meetings are held on fortnightly on Wednesdays at 23:30 UTC (Thursday 9:30am Australian Eastern Standard Time or GMT+10, Wednesday 4:30pm Pacific Standard Time) on the #openstack-meeting-4 IRC channel.

Previous meetings took place on Google Hangouts - Meeting link: User Guide Team Hangout

Agenda for next meeting

Meeting agenda page

MeetingLogs

Team members

Joseph Robinson, Team Lead, Brisbane Australia (UTC+10)
Brian Moss, Rackspace, Brisbane Australia (UTC+10)
Tanja Roth, SUSE, Germany (UTC+1)
Bernd Bausch, Japan. Not quite certain yet to what extent I can contribute.
Deepti Navale, Red Hat, Sydney Australia (UTC+10)
Alexandra Settle, Rackspace, Brisbane Australia (UTC+10)
Darren Chan, Rackspace, Canberra Australia (UTC+10)
Emett Speer, Vancouver, Canada (UTC+8)

User Task Matrix

Task	Operators	System Administrator	End Users
Planning Installations	7	7	1
Networking Setup	10	10	1
Creating Projects	10	10	0
Creating Instances	10	10	2

@@ Line 40: / Line 40: @@
 ===MeetingLogs===
 *
-== RST Conversion Issues ==
-*RST issues in converting tables when tables are codeblocks.
-**RST documents impose a 79 character limit when building files in .rst format. When tables exceed that limit, a list table role can help create content in a new table without exceeding the character limit. The issue is when a table is generated by an OpenStack service, and returned as a result of a command. These tables are constructed with +, -, and | characters. The table created by a list table role has solid lines forming rows, columns, and cells. The content is similar, however users might be surprised by a table with solid lines rather than a table built with +, -, and | characters. Is there a role or other filter than can be applied to list tables to make them appear as a table that might turn up in code block (+--------+)?
-*Large scale content inside tables.
-**When building tables with a list table role, some items that appear inside the table cells might exceed the 79 character limit. Is there a solution to recreating this large scale content in a table such that it does not affect the character limit?
-*The :orphan: role and references.
-**Files with an :orphan: role at the top of the file, not included in the toc tree, will not link to another file when the :ref: role is used to link to the file from a different file. Is there a solution to this linking issue?
-*Pandoc conversion problems.
-**When converting files with Pandoc, some entries in the .xml file will not convert accurately. Procedure titles and sub section titles will not parse correctly, and will be deleted from the converted document. Pandoc also removes procedure numbering. Currently, the solution is to compare the complete .rst file to the built .xml version, and check the headings, subheadings, and procedure numbers to make sure they are correct, and line up with original. This is an issue that could also be discussed.
-*Contact details for RST issues that we can't solve:
-** Author:	David Goodger
-** Contact: docutils-develop@lists.sourceforge.net
 == Team members ==