User Guides

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.

We focus on:

• Cloud Admin Guide (migrating to RST)
• End User Guide (migrating to RST)
• Admin User Guide (migrating to RST)

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

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.
• Blueprints 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 Google Hangouts. If you're not on the google calendar invitation list and want to be, please make yourself known to Joseph or Brian through IRC or the Openstack-Doc mailing list.

Action Items

• Thursday 06/25/15
  • Update Calendars and Meeting times for the next meetings - change to fortnight - Joe

• Thursday 06/18/15
• Thursday 06/11/15
  • Updated Documentation/Migrate wiki table for Cloud Admin Guide with Networking.xml conversion chapters marked as "On Hold" - Alex - DONE

• Thursday 06/04/15
  • Email out request for Cloud Admin Guide repository freeze. - Brian, Joe. - DONE
  • Linking RST conversion to the User Guide improvement blueprints - Brian - DONE
  • Move HOT guide from heat repository - Brian (https://bugs.launchpad.net/openstack-manuals/+bug/1461720)
  • HowTo overhaul discussion, and HowTo for first timers. Brian

Agenda for next meeting

• Thursday 07/09/15
  • Tables - are the list tables building correctly - screen cap tables or code segments that were in +-----+ format.
  • Any conversion points: pandoc cut out some headings - adding them back in during review.

• Thursday 06/25/15
  • RST check in: any questions or discussions?
  • Any returning members need an update?
  • Any bugs for cloud admin to tag, pause, or merge?

• Thursday 06/18/15
  • Action items from last meeting - networking sections tagged
  • Networking sections updates
  • Any past items to discuss

• Thursday 06/11/15
  • Action items from last meeting - All either Done or Doing.
  • Cloud Admin Guide RST Conversion - Hold off on converting networking sections, as these may be removed entirely
  •  :option: tagging note - :orphan: directive for common files
  • Any past items to discuss.

• Thursday 06/04/15
  • Cloud Admin Guide RST Conversion
  • Cloud Admin Guide bugs: This one https://review.openstack.org/#/c/187339/5
• IA Update post conference.

• Thursday 05/28/15
  • The Cloud Admin Guide RST Conversion is now a priority follow the summit. So this crosses off a question from

two weeks ago on whether the guide was in our scope. There is a task tracking table added to the RST migration page on the Wiki.

• • There is now a new heading on the RST conversion task tracking page.
  • Question for experienced writers - Where to start from here?
• IA Update:
  • Rename the Virtual Machine Image Guide to the Cloud Image Guide
  • Admin Guide versioning. One consideration is to add versioning to the Admin Guide
  • Move Hot Guide from End User Guide to Heat repo
  • Rewriting the How-To section, resulting in doc that has ease of readability. This must avoid duplication of the infra-manual.

• Thursday 05/14/15
  • Will the scope include Cloud Admin Guide alongside the User and Admin Guides?
  • The tasks tracking page is now active: https://wiki.openstack.org/wiki/Documentation/ReorganizeUserGuides
  • https://review.openstack.org/#/q/status:open+branch:master+topic:separate-user-guide,n,z : A list of patches to review as a priority to.

Team members

• Brian Moss, Rackspace, Brisbane Australia (UTC+10)
• Joseph Robinson, 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)

---