Open Stack

Hi all,
Just kicked off announcing another round for the Outreach Program for
Women, exciting! I also wanted to give a round up from the world of docs so
here goes.

1. In review and merged this past week:

We've had a good number of reviews going through as well as changes to doc
tools to improve including JSON validation. Also you can now substitute
docs-draft instead of logs in the URL from a review and see built
documentation. WOO.

2. High priority doc work:

I'd say our first priority is bug triage and fixing, for core projects
first. For the operator docs (openstack-manuals) we're at 360 open bugs
with over 50 to be triaged. For the API docs we have about 150 open bugs.

I attended the Trove mid-cycle meetup last week. They've got their API docs
as a priority, and have a writer assigned to work on install docs. This is
great news! So reviewers, be ready to take a look at patches.

As always, the install guide is a high priority. We're having a good
discussion about the install guide and default configuration on the
openstack-docs mailing list, feel free to join us.

3. Doc work going on that I know of:

Matt Kassawara and install crew have been working on a 3-node install with
neutron on icehouse, nice work! Thanks Phil Hopkins,

The final-final edits to the Operations Guide ship today to go to their
production team. I have been porting to the feature/edits branch about once
a week to keep our master branch where we do reviews, and the feature/edits
branch where production will occur. I'll back port the index entries about
once a week.

Shaun McCance continues to work on scraping code for configuration options
information and ensuring we capture all of the options across projects.

4. New incoming doc requests:

On the openstack-dev list we've had a conversation [2] about adding a Heat
template authors chapter to the End User Guide. Who's interested in this?
I'm going to ask a few select people I have in mind but also wanted to let
you all know we're looking for great integration there.

5. Doc tools updates:

In order to publish Markdown documents like the Image API v2 spec, Andreas
worked hard to get the openstack-doc-tools utility released a few times.
Release notes are here:
https://github.com/openstack/openstack-doc-tools#release-notes. Next up for
the doc tools are testing JSON and XML API sample requests and responses
(which uncovered over 80 flaws). Great improvements here.

6. Other doc news:

I've sent a request to add three questions about API documentation to the
User Survey. [1]

Diane split the Conventions page into three parts: Writing Style, DocBook
Markup, and WADL Markup.

I'm in San Antonio this week for an internal developer conference, so I'll
be less available on IRC than usual. Still planning to run the weekly docs
meeting though, so join in the fun! This week is the 4th Wednesday, see you
at 14:00:00 UTC in #openstack-meeting-alt.

[1]
http://lists.openstack.org/pipermail/user-committee/2014-February/000242.html
[2]
http://lists.openstack.org/pipermail/openstack-dev/2014-February/027129.html
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20140224/98158337/attachment.html>