29 May 2015
Continuing in Anne's fine tradition, I intend to send these out every Friday. If you have content you would like to add, or you would like to be added to the distribution list, please email me directly at email@example.com.
The Design Summit was, I think, a great success. We had ten sessions for docs overall, including two workgroups and a contributors' meetup. Thanks to everyone who came along (or participated remotely!) and had their say on the Liberty release. I've been spending time gathering my thoughts after the Summit, and have summarised the etherpad notes on the wiki here: https://wiki.openstack.org/w/index.php?title=Documentation/Liberty You can also see the original etherpads here: https://wiki.openstack.org/wiki/Design_Summit/Liberty/Etherpads#Documentation
In short, the main things I would like us to achieve for Liberty are:
- RST conversion: Install Guide, Cloud Admin Guide, HA Guide
- User Guides information architecture overhaul.
- Greater focus on helping out devs with docs in their repo
- Improve how we communicate with and support our corporate contributors
If you have a burning issue that didn't get addressed during the Summit, or that you think I've forgotten, now would be your chance to tell me about it! Look out for Blueprints and Specs for this work over the next couple of weeks.
__Doc team meeting__
APAC meeting was help this week, see the minutes here to catch up: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-05-27
Thanks to Joe for holding the APAC fort while I was travelling!
Next meetings are: US: Wednesday 3 June, 14:00:00 UTC #openstack-meeting APAC: Wednesday 10 June, 00:30:00 UTC #openstack-meeting
Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting
The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, and the HA Guide.
- Install Guide:
Contact Karin Levenstein <firstname.lastname@example.org> Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/installguide-liberty Spec WIP: https://review.openstack.org/#/c/183138/
- Cloud Admin Guide:
We are working to resolve translation tool expectations with the i18N team. I want to publish the RST-based English End User Guide and Admin User Guide once we're all comfortable with the way forward. Daisy will discuss the implications at the next i18N team meeting Thursday at 0800 UTC, and we'll implement and communicate the plan.
Next on the list is Networking Guide testing and reviewing. The Networking Guide team has a talk in Vancouver and needs to get their guide in shape for publishing. The neutron team is holding a doc day April 23. Please join in -- they'll post details in their notes.
_First App Tutorial_
There's also the First Application Tutorial that needs to finish the spec and needs an editing cleanup prior to publishing. Ideally that will happen before Vancouver, we need to get it to the finish line.
With everything else going on we need an updated spec for the HA Guide - the wiki page isn't enough. Based on this week's doc team meeting it sounds like that can go to RST as well but we need it in the spec so we can plan and cross-coordinate with the other priorities leading up to Vancouver.
_Vancouver Summit _ The docs team has four Fishbowl time slots, 2 Workroom slots, and 1 Meetup allocated now. If you'd like to discuss a cross-project idea, please use the form to suggest new ideas: http://goo.gl/forms/S69HM6XEeb. You can see the current suggestions already posted here: https://docs.google.com/spreadsheets/d/1vCTZBJKCMZ2xBhglnuK3ciKo3E8UMFo5S5lmIAYMCSE/edit?usp=sharing
Lana or I will send out an etherpad in the next week or so with topic suggestions for our allocation.