Welcome to the home page for the Install Guide Specialty Team!
About the Install Guide team
Specialty team for developing and maintaining the OpenStack Install Guide.
How to contribute
Contrary to most other OpenStack documentation, the installation guide includes a precise series of instructions to install a complex software suite. The primary audience involves people unfamiliar with OpenStack who simply want to evaluate it with minimal hassle and frustration. To meet these requirements, we (the contributors) thoroughly test the installation guide to verify functionality prior to a release and periodically thereafter to catch minor issues, usually involving changes to packaging.
Over the last several releases, the installation guide has become mature enough that most bugs involve user error rather than problems with the installation guide. Simply assuming a bug involves an actual problem with the installation guide, contributing a patch, and approving that patch without further investigation (sometimes involving testing) carries a significant chance of breaking the guide, often in obscure ways. To keep the installation guide operational, we must use the following procedure to properly triage bugs, contribute, and review patches:
- Do not confirm or triage your own bug. Wait for someone on the installation guide sub-team to change the status or initiate a discussion about it.
- Do not confirm or triage a bug unless you can verify an actual problem with the installation guide. In some cases, the bug description provides enough information to make a quick decision, but most of the time requires discussion or testing in a lab environment prior to confirming or triaging it.
- For the most part, only members of the installation guide sub-team should triage a bug.
- Do not contribute a patch for a bug without triage status.
- Do not vote +1/+2 or approve a patch that references a bug without triage.
- If a patch lacks reference to a bug, vote -1 and notify the contributor to correct the commit message.
- If any doubt exists with a patch, initiate discussion and/or test it in a lab environment prior to voting +1/+2 or approving it.
- For the most part, only members of the installation guide sub-team should vote +2 or approve a patch.
To improve clarity of bug triage policy and processes, please review the following bugs:
- Completed documentation specs
- Liberty install guide blueprint
- Liberty Documentation Testing - Installation Guide and Configuration Reference
Meetings are weekly on Tuesdays at 13:00 UTC (8:00 AM US CDT)
For the month of August, we are alternating meeting times; the meetings on the 11 and 25 August will be at 23:00 UTC (6:00 PM US CDT)
- Karin Levenstein, team lead
- Bernd Bausch, interested in more readable and complete install guides
- Pranav Salunke, interested in maintaining openSUSE, SLES sections of installa guides. Also creating tools for automated testing and making it easy to work on install guides.
- Christian Berendt, migration to RST, automated testing and updating (screenshots, outputs), no preference for a distribution (can take care of Fedora/RHEL/CentOS, this is my primary set of distributions)
- Matt Kassawara, doing this for a while now.
- Alex Adamov, Debian
- Karen Bradshaw, help convert the install guide to RST
- Harry Sutton, interested in maintaining currency and accuracy in the install guides. I work for HP in Technology Services and worry about things like serviceability.
- Brian Moss, interested in improving the guides
- Tom Fifield, fighting for the users
- Name, role/interests
- Review: Debian install guide spec
- Review: General Liberty install guide spec (to be updated after RST conversion)
- Installation Guide migration