[OpenStack-docs] What's Up, Doc? 17 July 2015

Lana Brindley openstack at lanabrindley.com
Fri Jul 17 05:46:03 UTC 2015


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi everyone,

I'm very pleased to announce that we finally have a name for our M
release: Mitaka (三鷹)! Accordingly, the Tokyo Summit for the Mitaka
release is only just over 100 days away. CFP closed a couple of days
ago, and I've noticed that the first round of ATC discount codes have
gone out. If you haven't got yours yet, then keep patching Liberty and
sit tight. The discount codes will come out in stages after every
snapshot. This week, we've had some great discussions about networking
scenarios in the Install Guide, and the best way to include RST files in
our newly converted books. We also have both the HA Guide and the Cloud
Admin Guide conversions in their final stages, and the Install Guide
conversion sprint coming up. Very exciting!

== Progress towards Liberty ==

* RST conversion:
** Install Guide: Conversion is now underway, sign up here:
https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
** Cloud Admin Guide: is nearly done. Sign up here:
https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration
** HA Guide: is also nearly done. Get in touch with Meg or Matt:
https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update
** Security Guide: Spec has merged. Planning is happening here:
https://etherpad.openstack.org/p/sec-guide-rst

* User Guides information architecture overhaul
** Waiting on the RST conversion of the Cloud Admin Guide to be complete

* Greater focus on helping out devs with docs in their repo
** Work has stalled on the Ironic docs, we need to pick this up again.
Contact me if you want to know more, or are willing to help out.

* Improve how we communicate with and support our corporate contributors
** I have been brainstorming ideas with Foundation, watch this space!

* Improve communication with Docs Liaisons
** I'm very pleased to see liaisons getting more involved in our bugs
and reviews. Keep up the good work!

* Clearing out old bugs
** A small amount of progress on the old bugs we held over from last
week. New ones to check out in this newsletter!

== RST Migration ==

The next books we are focusing on for RST conversion are the Install
Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would
like to assist, please get in touch with the appropriate speciality team:

* Install Guide:
** Contact Karin Levenstein <karin.levenstein at rackspace.com>
** Sign up here:
https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
** There's a sprint happening on this book later next week. Info and
sign up here:
https://wiki.openstack.org/wiki/VirtualSprints#Installation_guide_conversion_from_DocBook_to_RST

* Cloud Admin Guide:
** Contact Brian Moss <kallimachos at gmail.com> & Joseph Robinson
<joseph.r.email at gmail.com>
** ** Sign up to help out here:
https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration

* HA Guide
** Contact Meg McRoberts <dreidellhasa at yahoo.com> or Matt Griffin
<me at mattgriffin.com>
** Blueprint:
https://blueprints.launchpad.net/openstack-manuals/+spec/improve-ha-guide

* Security Guide
** Contact Nathaniel Dillon <nathaniel.dillon at hp.com>
** Bug: https://bugs.launchpad.net/openstack-manuals/+bug/1463111
** Info: https://etherpad.openstack.org/p/sec-guide-rst

For books that are now being converted, don't forget that any change you
make to the XML must also be made to the RST version until conversion is
complete. Our lovely team of cores will be keeping an eye out to make
sure loose changes to XML don't pass the gate, but try to help them out
by pointing out both patches in your reviews.

== Install Guide RST Conversion Sprint ==

In order to kick off the RST conversion of the Install Guide, the
speciality team have decided to run a virtual conversion sprint over two
days on July 22-24. For more information, see the
https://wiki.openstack.org/wiki/VirtualSprints#Installation_guide_conversion_from_DocBook_to_RST
wiki page, and the
https://etherpad.openstack.org/p/installguide-rst-virtual-sprint etherpad.

== HA Guide Works ==

With the RST conversion on the HA Guide wrapping up, the HA Guide
speciality team are looking for people to help out with the
reorganisation and writing the new content. They have quite a few bugs
to get through, and they need your help! Contact Matt Griffin, or any
other member of the HA Guide Speciality Team, or join their weekly IRC
meeting. Details here:
https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update

== Docs Tools ==

Last week, we released openstackdocstheme 1.1.0, see
http://lists.openstack.org/pipermail/openstack-announce/2015-June/000392.html.
The main new features in this release are improvements for bug
reporting, variable lists like the glossary are now indented, and
next/prev links are now icons on the upper right part of the page.

Additionally, the stable/icehouse branch of openstack-manuals has been
EOLed, no further updates will be done from it. For more information, see
http://lists.openstack.org/pipermail/openstack-infra/2015-July/002888.html

== Doc team meeting ==

The next meetings are:

APAC: Wednesday 22 July, 00:30:00 UTC
US: Wednesday 29 July, 14:00:00 UTC

Please go ahead and add any agenda items to the meeting page here:
https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

== Spotlight bugs for this week ==

We've now got people assigned to work on last week's old bugs, which is
great! Here are three more rusty old bugs that could use some love:

https://bugs.launchpad.net/openstack-manuals/+bug/1241116 Using policies
for protected properties

https://bugs.launchpad.net/openstack-manuals/+bug/1241179 Add
notifications for groups and roles

https://bugs.launchpad.net/openstack-manuals/+bug/1251060 Xenapi: Allow
windows builds with xentools 6.1 and 6.2

- --

Remember, if you have content you would like to add to this newsletter,
or you would like to be added to the distribution list, please email me
directly at openstack at lanabrindley.com, or visit:
https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana

- -- 
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVqJabAAoJELppzVb4+KUyDkoIAKIiNrURthUi+Dzj86zkfQHA
dKOHDBIfGmeDgQ059EE+oiuJI8qM+xqvz7zTXAGFhMDzEQ4rfx1lJd6UWwyohwdJ
80hNK696YjsKIIHelN+7zFuzG6jdWHtx9mdVLbnaBU+k0HYDRIEmkyIlRw9WIJRD
YKCRvvijN0Dgwj5EQoyFYSM3/6BQlO1jyX2qf8zUkTjbKKr5d1yJqAnzAXEz0rD0
Hwa7CKVJXaxs1dIF9kdgYFqp+tUHfCRnfD8kQ+CgDpZiZmraXe8mgXFCoSufKCxW
FkqfADfnRWHywnC/G9EtlOWdy8tLsM2CB7GZcicvVIAYIRa3ws/xy6JI/C/fsRU=
=4chR
-----END PGP SIGNATURE-----



More information about the OpenStack-docs mailing list