Documentation/HA Guide Update

= HA Guide Update =

What
Let's update the OpenStack HA Guide. Based on direction from Anne Gentle, we will follow a similar path as the Security Guide -- subject matter experts working with core docs team members for reviews.

In addition to addressing the bug list (https://bugs.launchpad.net/openstack-manuals/+bugs/?field.tag=ha-guide), this effort will update all aspects of the guide to be more current and provide richer information and advice about OpenStack HA.

We've created an etherpad to capture ideas and start to form a plan for what is going to be updated, in what way, and who is responsible.

Meetings take place in #openstack-meeting-3. Team members may communicate on relevant topics via the OpenStack Docs mailing list by using "[ha-guide]" at the beginning of the subject line.

Next Meeting
There is no participants, so please just contact #beekhof on irc if we have any items to discuss.

Agenda
 * Info about OpenStack HA community WIP on auto-evac of instances
 * Addressing TODO sections of the HA guide
 * Testing the HA guide how-to steps
 * Open discussion

Past Meetings
Thursday, November 19 at 8:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * Created a survey for a new meeting time
 * Open discussion

Thursday, September 17 at 8:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * Continue to review copy - IN PROGRESS
 * Create a survey for a new meeting time - IN PROGRESS

Thursday, September 10 at 8:00 pm UTC on #openstack-meeting-3

Agenda
 * No meeting today

Thursday, September 3 at 8:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * Update on content review
 * Update on translations
 * Transition
 * New meeting times

Thursday, August 13 at 8:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * Review todo's from last meeting
 * Update on content review

Thursday, August 6 at 8:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * Review action items from last week's minutes
 * Review HA Guide topics status

Thursday, July 30 at 8:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * Review action items from last week's minutes
 * Review HA Guide topics status

Thursday, July 23 at 8:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * Review action items from last week's minutes
 * Review HA Guide topics status

Thursday, July 16 at 8:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * Review action items from last week's minutes
 * Review HA Guide topics status

Thursday, July 9 at 8:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * Review HA Guide topics status

Thursday, July 9 at 8:00 pm UTC on #openstack-meeting-3
 * No meeting

Thursday, June 25 at 8:00 pm UTC on #openstack-meeting-3

Agenda
 * Review HA Guide topics status
 * Timeline update

Useful links:
 * Current build of merged content: http://docs.openstack.org/draft/ha-guide/index.html
 * Working list that includes bugs associated with each topic: https://etherpad.openstack.org/p/openstack-haguide-update-next-steps

Thursday, June 18 at 8:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * Review HA Guide topics status
 * Need to identify writers and SMEs
 * Poke on reviews

Thursday, June 11 at 8:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * Review proposed timeline
 * Status on RST migration
 * HA Guide reviews needed
 * Other agenda topics

Action items
 * 1) mattgriffin contact the contributors that came to the room in Vancouver to contribute
 * 2) mattgriffin and nickchase will do reviews of megm's CRs in https://etherpad.openstack.org/p/openstack-haguide-update-next-steps
 * 3) Need a technical person to own the flow of the doc through having the Controllers configured
 * 4) Meg to send Matt names of other contributors
 * 5) Misc: Need a technical person to own the flow of the doc through having the Controllers configured

Thursday, June 4 at 8:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * Recap Vancouver Summit outcomes
 * Proposed process to convert from docbook to RST, rework structure, and add new content - Next Steps
 * 1) Convert existing HA Guide from docbook to RST and as much as possible in the new table of contents structure (megm leading). Focus on technical aspects of conversion. Do content changes/updates later in bugs/CRs.
 * 2) Publish new Liberty HA Guide from new RST version (Current version can be viewed at http://docs.openstack.org/draft/draft-index.html, as soon as https://review.openstack.org/187687 and https://review.openstack.org/187686 are merged). Draft is available at http://docs.openstack.org/draft/ha-guide/.
 * 3) Solicit reviews from PTLs and SMEs. Get them to file content bugs on incorrect technical content or gaps. (all HA Guide team)
 * 4) HA Guide team writes updated content (all HA Guide team) - complete by mid-cycle?
 * 5) Involve translations team as content matures
 * 6) As part of this effort, we should be checking the relevant content in the Configuration Reference Guide (http://docs.openstack.org/kilo/config-reference/content/index.html) to ensure that the HA config options are represented appropriately.
 * Continue to accept docbook contributions to existing HA Guide? mattgriffin & megm recommend Yes.... Until the conversion is complete?

Thursday, May 21 at 10:45am PT in Vancouver

Agenda
 * HA Guide Hackathon in Vancouver - in-person and virtual (Hangout link)

Thursday, May 14 at 8:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * Docs start by megm - https://review.openstack.org/#/c/182972/1
 * HA Guide Hackathon in Vancouver - in-person and virtual

Thursday, May 7 at 8:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * Review changes to TOC
 * Spec review status
 * HA Guide structure in place (Thanks Andreas! See his announcement.)
 * xrefs to Install Guide. Need prototype?
 * Next steps to writing content

No meeting on Thursday, April 30 at 8:00 pm UTC on #openstack-meeting-3

Thursday, April 23 at 8:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * mattgriffin: Spec (draft) submission status
 * Vancouver meeting date/time for Shamail to reserve a spot - Target is Thursday from 10:45-12:15P PT for now

Welcome jpena, erikmwilson, and Nikolay_St!

Thursday, April 16 at 8:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * Action items from last week
 * megm_ update the Launchpad blueprint
 * mattgriffin update progress on writing a spec - guide / draft in progress
 * nickchase work on converting docs
 * nickchase review ToC with Bogdan
 * Do by Vancouver - Crude project plan feedback?

Thursday, April 9 at 9:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * nickchase work on converting docs
 * nickchase review ToC with Bogdan
 * add priorities (P1, P2, P3, etc) next to each section title in the ToC
 * next steps?
 * other items

Thursday, April 2 at 9:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * Action items from last meeting
 * how to convert (nickchase)

Thursday, March 26 at 9:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * Terminology question: "storage provider" or "storage backend"?
 * Action items from last meeting
 * update on whether people reviewed TOC and when can we consider it finalized to start making further progress

Thursday, March 19 at 9:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * Review action items from last meeting
 * megm review the Docs team email draft on the pad
 * check with sam-i-am and nickchase on starting a "new" doc structure
 * mattgriffin & nickchase: enlist people
 * Start assigning content & sections from TOC

Thursday, March 12 at 9:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * Review HA Guide update for Docs
 * Outline/TOC update
 * Updates on other contributors from Mirantis, Percona, and other orgs

Thursday, March 5 at 9:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * Review last meeting actions
 * Next actions. Content structure?

Thursday, February 26 at 9:00 pm UTC on #openstack-meeting-3

Agenda
 * TBD

Thursday, February 19 at 9:00 pm UTC on #openstack-meeting-3 (minutes)

Agenda
 * 1) Review what we discussed last Tuesday (Feb 17) in a Hangout (notes)
 * 2) Update on content structure

Action items
 * Review and update the Table of Contents
 * megm_ will start to add links to the TOC for content to keep/replace and links to the related areas in the Install Guide
 * wait on converting until the TOC is done-ish

Thursday, February 5 at 9:00 pm UTC on #openstack-meeting-3

Action items from last meeting:
 * DONE Start an discussion about content structure (see Feb 17 Hangout notes link above)
 * Add hangout URL to the agenda for next week on the wiki page
 * Continue to find and triage content bugs

Agenda
 * 1) Content structure changes

Thursday, January 29 at 9:00 pm UTC on #openstack-meeting-3 (irc log)

Agenda
 * 1) Bug bash results
 * 2) Next steps - triage the open bugs and possible assignment of bugs
 * 3) Update on getting added to the OpenStack Calendar. Thanks Sriram!

Thursday, January 22 at 9:00 pm UTC on #openstack-meeting-3 (irc log)

Agenda
 * 1) Update on ACTION items from last meeting
 * 2) DONE ACTION (All): Update wiki with the project that you are investigating
 * 3) IN PROGRESS ACTION (Sriram): Check how we can get this meeting on the OpenStack Calendar
 * 4) DONE ACTION (Sriram): Can we move meetings to an official IRC channel
 * 5) Bug bash on January 23 focused on existing bugs

Thursday, January 15 on #openstack-haguide (irc log)
 * 1) Regular meeting time
 * 2) Existing bugs - Plan to resolve
 * 3) Need an owner for finding out from PTLs which projects work in a/a or a/p

Wednesday, October 29 on #openstack-haguide (irc log)

Where
Join the group in #openstack-meeting-3 to chat about this effort. Regular meetings are for 30 minutes on each Thursday at 3pm US Central.

Project HA Status Tracker
This section is intended to be used by the HA Guide Update team to track HA considerations for OpenStack integrated projects (created due to a request during the 01/15/15 meeting). This information will be used as we build an updated TOC and also help determine content for each project. Integrated projects information obtained from programs.yaml.

Bug Bash

 * 1) Whenː 01/23/2014
 * 2) Whereː online

Logistics
Open Bugsː Link
 * 1) Tag to useː ha-guide
 * 2) Version of Book to file bugs againstː HTML Version

Suggested Priority

 * 1) Pri0ː Stale/ Incorrect info (for instance wrong config, incorrect settings etc)
 * 2) Pri1ː Missing Info (like new chapters to add, topics to cover etc)
 * 3) Pri2ː Cosmetic Errors/ Sentence formation etc

Things to Note

 * 1) Use the little 'bug' icon to auto-magically create a bug entry with relevant info such as chapter name, page, url. You can add more details like tag, description as required.
 * 2) Include as many details as possible, chapter #, location etc in the book.
 * 3) Include OpenStack Versions if applicable