Jump to: navigation, search

Difference between revisions of "User Guides"

(→‎Meetings)
 
(62 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
Welcome to the home page for the User Guide Specialty Team!
+
We are the User Guides Specialty team!  
  
 
== About the User Guide team ==
 
== About the User Guide team ==
  
−
This team is all about the users.  
+
This team is all about the users. We support companies who reuse upstream content from the guides, and focus on information architecture, consistency, and conventions in the guides.
  
−
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 maintain:
  
−
We focus on maintaining:
+
* Openstack Admin Guide
−
 
 
−
* Cloud Admin Guide
 
 
* End User Guide
 
* End User Guide
−
* Admin User Guide
 
−
 
  
 
For the Install Guide and the Networking Guide, see those respective speciality groups.
 
For the Install Guide and the Networking Guide, see those respective speciality groups.
Line 18: Line 14:
 
== Quick links ==
 
== Quick links ==
  
−
*User Guide Team Meeting information [https://wiki.openstack.org/wiki/Meetings/DocUserGuidesTeamMeeting Instructions]
+
*User Guide Team Meeting information [https://wiki.openstack.org/wiki/Meetings/DocUserGuidesTeamMeeting Meeting Instructions and Agenda]
−
*Blueprint for reference and implementation [https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised Blueprints]
+
*Task List [https://wiki.openstack.org/wiki/Documentation/ReorganizeUserGuides User Guide Task List].
 +
*Blueprint for editing the User Guides [https://blueprints.launchpad.net/openstack-manuals/+spec/user-guide-editing]
 +
*(Previous Tasks)Blueprint for reference and implementation [https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised Blueprints]
 +
 
 +
== Team members ==
 +
 
 +
* Joseph Robinson, Team Lead, Rackspace, Brisbane Australia (UTC+10)
 +
* Gudrun Wolfgram, IBM, US.
 +
* Linette Williams,  IBM, US.
 +
* Bernd Bausch, Japan. Not quite certain yet to what extent I can contribute.
 +
* Tanja Roth, SUSE, Germany (UTC+1)
 +
* Emett Speer, Vancouver, Canada (UTC+8)
 +
* Alexandra Settle, Rackspace, London, United Kingdom (UTC)
 +
* Brian Moss, Rackspace, Brisbane Australia (UTC+10)
 +
* Darren Chan, Rackspace, Canberra Australia (UTC+10)
 +
* Deepti Navale, Red Hat, Sydney Australia (UTC+10)
  
 
== Housekeeping ==
 
== Housekeeping ==
Line 30: Line 41:
 
== Meetings ==
 
== 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  
+
'''The User Guide Specialty Team Meetings previously ran monthly on IRC. Currently, these meetings are suspended, with the options of using the time for User Guide discussion if needed. User Guides are regularly discussed in the [https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting OpenStack Docs Meeting]'''
−
''#openstack-meeting-4'' IRC channel.  
+
 
 +
We hold one monthly meeting on the ''#openstack-meeting-4'' IRC channel:
 +
 
 +
* '''Doc User Guides Meeting''' on Wednesdays at [06:30 AM UTC http://www.timeanddate.com/worldclock/fixedtime.html?msg=User+Guide+Specialty+Team+Meeting&iso=20161208T1630&p1=47 ] (Thursday 4:30pm Australian Eastern Standard Time or GMT+10, Wednesday 4:30pm Pacific Standard Time)
 +
 
 +
 
 +
We have a page with instructions on running meetings with MeetBot, which is the same tracker used in the Weekly OpenStack Docs meetings - [https://wiki.openstack.org/wiki/Meetings/DocUserGuidesTeamMeeting Meeting Instructions and Agenda]
 +
 
 +
Get an ical file here: http://eavesdrop.openstack.org/#Documentation_User_Guides_Team_Meeting
  
 
Previous meetings took place on Google Hangouts  - Meeting link: [https://plus.google.com/hangouts/_/calendar/OHEzajk1ZjB2djRmZW9tMnB1cjNsdGRrMWtAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ.8amajg4mrflp20h0fi0ij7mlmo User Guide Team Hangout]
 
Previous meetings took place on Google Hangouts  - Meeting link: [https://plus.google.com/hangouts/_/calendar/OHEzajk1ZjB2djRmZW9tMnB1cjNsdGRrMWtAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ.8amajg4mrflp20h0fi0ij7mlmo User Guide Team Hangout]
  
 
=== Agenda for next meeting ===
 
=== Agenda for next meeting ===
−
[https://wiki.openstack.org/wiki/Meetings/DocUserGuidesTeamMeeting Meeting agenda page]
+
The meeting agenda page - [https://wiki.openstack.org/wiki/Meetings/DocUserGuidesTeamMeeting Meeting Instructions and Agenda]
  
 
===MeetingLogs===
 
===MeetingLogs===
 +
Meeting 09/11/16
 +
 +
* Minutes:        http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-11-10-06.34.html
 +
* Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-11-10-06.34.txt
 +
* Log:            http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-11-10-06.34.log.html
 +
 +
 +
Meeting 02/11/16
 +
US Meeting
 +
*Minutes:        http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-11-02-21.01.html
 +
*Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-11-02-21.01.txt
 +
*Log:            http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-11-02-21.01.log.html
 +
 +
APAC Meeting
 +
*
 +
 +
Meeting 21/09/16
 +
US Meeting
 +
*Minutes:        http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-09-21-21.03.html
 +
*Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-09-21-21.03.txt
 +
*Log:            http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-09-21-21.03.log.html
 +
 +
APAC Meeting
 
*
 
*
 +
Meeting 21/07/16
 +
US Meeting
 +
*Minutes: http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-07-20-21.19.html
 +
*Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-07-20-21.19.txt
 +
*Log:            http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-07-20-21.19.log.html
 +
 +
APAC Meeting
 +
*No Meeting this fortnight
 +
 +
Meeting 07/07/16
 +
US Meeting
 +
*Minutes:        http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-07-06-21.01.html
 +
*Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-07-06-21.01.txt
 +
*Log:            http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-07-06-21.01.log.html
 +
 +
APAC Meeting
 +
* No meeting this fortnight
 +
 +
Meeting 15/06/16
 +
US Meeting
 +
*Minutes:        http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-06-15-21.06.html
 +
*Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-06-15-21.06.txt
 +
*Log:            http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-06-15-21.06.log.html
 +
 +
APAC Meeting
 +
* No meeting this fortnight
  
−
== RST Conversion Issues ==
+
Meeting 02/06/16
 +
US Meeting
 +
*Minutes:        http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-06-01-21.00.html
 +
*Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-06-01-21.00.txt
 +
*Log:            http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-06-01-21.00.log.html
  
−
*RST issues in converting tables when tables are codeblocks.
+
APAC Meeting
−
**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 (+--------+)?
+
*Minutes:        http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-06-01-23.30.html
−
*Large scale content inside tables.
+
*Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-06-01-23.30.txt
−
**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?
+
*Log:           http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-06-01-23.30.log.html
−
*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:
+
Meeting 19/05/16
−
** Author: David Goodger
+
US Meeting
−
** Contact: docutils-develop@lists.sourceforge.net
+
*Minutes:        http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-05-18-21.01.html
 +
*Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-05-18-21.01.txt
 +
*Log:            http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-05-18-21.01.log.html
 +
 
 +
  APAC Meeting
 +
*Minutes:        http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-05-18-23.31.html
 +
*Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-05-18-23.31.txt
 +
*Log:            http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-05-18-23.31.log.html
 +
 
 +
Meeting 03/23/16
 +
US Meeting
 +
* Minutes:        http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-03-23-21.20.html
 +
* Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-03-23-21.20.txt
 +
* Log:            http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-03-23-21.20.log.html
 +
 
 +
APAC Meeting
 +
* Minutes:        http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-03-23-23.39.html
 +
* Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-03-23-23.39.txt
 +
* Log:            http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-03-23-23.39.log.html
 +
 
 +
Meeting: 03/09/16
 +
US Meeting
 +
*Minutes:        http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-03-09-22.03.html
 +
*Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-03-09-22.03.txt
 +
*Log:            http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-03-09-22.03.log.html
 +
 
 +
APAC Meeting
 +
*Minutes:        http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-03-10-00.33.html
 +
*Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-03-10-00.33.txt
 +
*Log:            http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-03-10-00.33.log.html
 +
 
 +
Meeting: 02/25/16
 +
US Meeting
 +
* Minutes:        http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-02-24-22.11.html
 +
* Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-02-24-22.11.txt
 +
* Log:            http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-02-24-22.11.log.html
 +
 +
  APAC Meeting
 +
* Minutes:        http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-02-24-23.33.html
 +
* Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-02-24-23.33.txt
 +
*  Log:            http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-02-24-23.33.log.html
 +
 
 +
 
 +
 
 +
Meeting: 02/18/16 (Additional Meeting)
 +
  US Meeting
 +
* Minutes:        http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-02-17-22.17.html
 +
* Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-02-17-22.17.txt
 +
* Log:            http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-02-17-22.17.log.html
 +
 
 +
  APAC Meeting
 +
* Minutes:        http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-02-18-00.05.html
 +
* Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-02-18-00.05.txt
 +
* Log:            http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-02-18-00.05.log.html
 +
 
 +
 
 +
Meeting: 02/11/16
 +
  US Meeting
 +
* Minutes:        http://eavesdrop.openstack.org/meetings/docsuserguides/2016/docsuserguides.2016-02-10-22.10.html
 +
* Minutes (text): http://eavesdrop.openstack.org/meetings/docsuserguides/2016/docsuserguides.2016-02-10-22.10.txt
 +
* Log:            http://eavesdrop.openstack.org/meetings/docsuserguides/2016/docsuserguides.2016-02-10-22.10.log.html
 +
 
 +
  APAC Meeting
 +
* Minutes:        http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-02-10-23.33.html
 +
* Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-02-10-23.33.txt
 +
* Log:            http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-02-10-23.33.log.html
 +
 
 +
 
 +
Meeting: 01/27/16
 +
* Minutes: http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-01-27-23.31.html
 +
* Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-01-27-23.31.txt
 +
* Log: http://eavesdrop.openstack.org/meetings/docuserguides/2016/docuserguides.2016-01-27-23.31.log.html
  
−
== Team members ==
 
  
−
* Joseph Robinson, Team Lead, Brisbane Australia (UTC+10)
+
Meeting: 12/17/15
−
* Brian Moss, Rackspace, Brisbane Australia (UTC+10)
+
* Minutes: http://eavesdrop.openstack.org/meetings/docuserguides/2015/docuserguides.2015-12-16-23.31.html
−
* Tanja Roth, SUSE, Germany (UTC+1)
+
* Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2015/docuserguides.2015-12-16-23.31.txt
−
* Bernd Bausch, Japan. Not quite certain yet to what extent I can contribute.
+
* Log: http://eavesdrop.openstack.org/meetings/docuserguides/2015/docuserguides.2015-12-16-23.31.log.html
−
* 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 ==
 
  
−
{| class="wikitable"
+
Meeting: 11/25/2015
−
|-
+
* Minutes: http://eavesdrop.openstack.org/meetings/docuserguides/2015/docuserguides.2015-11-25-23.44.html
−
! Task !! Operators !! System Administrator !! End Users
+
* Minutes (text): http://eavesdrop.openstack.org/meetings/docuserguides/2015/docuserguides.2015-11-25-23.44.txt
−
|-
+
* Log: http://eavesdrop.openstack.org/meetings/docuserguides/2015/docuserguides.2015-11-25-23.44.log.html
−
| Planning Installations || 7 || 7 || 1
 
−
|-
 
−
| Networking Setup || 10 ||10 || 1
 
−
|-
 
−
| Creating Projects || 10 || 10 || 0
 
−
|-
 
−
| Creating Instances || 10 || 10 || 2
 
−
|}
 
  
  
−
----
 
 
[[Category:Documentation]]
 
[[Category:Documentation]]

Latest revision as of 05:17, 6 April 2017

We are the User Guides Specialty team!

About the User Guide team

This team is all about the users. We support companies who reuse upstream content from the guides, and focus on information architecture, consistency, and conventions in the guides.

We maintain:

  • Openstack Admin Guide
  • End User Guide

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

Quick links

Team members

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

Housekeeping

Meetings

The User Guide Specialty Team Meetings previously ran monthly on IRC. Currently, these meetings are suspended, with the options of using the time for User Guide discussion if needed. User Guides are regularly discussed in the OpenStack Docs Meeting

We hold one monthly meeting on the #openstack-meeting-4 IRC channel:


We have a page with instructions on running meetings with MeetBot, which is the same tracker used in the Weekly OpenStack Docs meetings - Meeting Instructions and Agenda

Get an ical file here: http://eavesdrop.openstack.org/#Documentation_User_Guides_Team_Meeting

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

Agenda for next meeting

The meeting agenda page - Meeting Instructions and Agenda

MeetingLogs

Meeting 09/11/16


Meeting 02/11/16 

US Meeting

APAC Meeting

Meeting 21/09/16 

US Meeting

APAC Meeting

Meeting 21/07/16 

US Meeting

APAC Meeting
  • No Meeting this fortnight

Meeting 07/07/16 

US Meeting

APAC Meeting
  • No meeting this fortnight

Meeting 15/06/16 

US Meeting

APAC Meeting
  • No meeting this fortnight

Meeting 02/06/16 

US Meeting

APAC Meeting

Meeting 19/05/16 

US Meeting

 APAC Meeting

Meeting 03/23/16 

US Meeting

APAC Meeting

Meeting: 03/09/16 

US Meeting

APAC Meeting

Meeting: 02/25/16 

US Meeting

 APAC Meeting


Meeting: 02/18/16 (Additional Meeting) 

 US Meeting

 APAC Meeting


Meeting: 02/11/16 

 US Meeting

 APAC Meeting


Meeting: 01/27/16


Meeting: 12/17/15


Meeting: 11/25/2015

Retrieved from "https://wiki.openstack.org/w/index.php?title=User_Guides&oldid=153045"