[openstack-dev] What's Up Doc? Mar 21, 2014

Anne Gentle anne at openstack.org
Fri Mar 21 19:18:13 UTC 2014

1. In review and merged this past week:

Lots of work to get the latest configuration reference groups for glance,
cinder, neutron, ceilometer, and trove. Thanks Gauvain for the efforts! You
can read more about the latest in his mailing list post, Config reference
news. [1]

Adding to our group of core reviewers definitely increased our review
times, thanks so much to our latest members and their reviewing efforts. We
merged over 50 patches in openstack-manuals alone.

What a great response to the copy-edits from O'Reilly, thank you all who
made those edits and reviewed them. Handoff today! Over 40 patches went
into the operations-guide repository in the last week. Great work.

Across all the doc repositories we are reviewing and merging about 10 a
day. Follow along to be a star doc reviewer by entering this in the Search
on review.openstack.org. (project:openstack/openstack-manuals OR
project:openstack/api-site OR project:openstack/object-api OR
project:openstack/image-api OR project:openstack/identity-api OR
project:openstack/compute-api OR project:openstack/volume-api OR
project:openstack/netconn-api OR project:openstack/operations-guide OR

2. High priority doc work:

Much appreciation to Matt Kassawara for creating architecture diagrams for
the Install Guide for Icehouse. The install guide remains a high priority
but we are still debugging packages to get a working install on distros.
For Ubuntu, security groups are not working. For RHEL/ RDO, Matt is testing
-3 (-2 had many database woes).

Matt also modified the docs in response to the UTF-8 configuration need for
MySQL at https://review.openstack.org/#/c/80799/.

3. Doc work going on that I know of:

I love what Edgar Magana has been doing lately to ping neutron developers
to ask them to write docs for a feature they've marked with DocImpact.
Great work, and good thinking. I know we'd like for each project to have
some point person looking out for docs, and Edgar has been a great model.
He talks about docs at each team meeting, answers questions, triages doc
bugs related to neutron, and seeks the people that will know the most about
a feature to write docs for it. Edgar's the model for project doc lead.

4. New incoming doc requests:

Release notes will be next and I've already asked for hints and tips on how
to gather up what's new in Icehouse. Steve Gordon has a sneak peek at [2].

5. Doc tools updates:

Andreas Jaeger just let us know that the translation jobs for api-site,
openstack-manuals, and operations-guide are now working properly. This is
great news! Read more at [3] to find out about upstream-translation jobs
and propose-translation jobs.

I've handed out two more Oxygen licenses so we're halfway through the set,
and it's good because it means that people are writing docs! Keep it up,
we're in the home stretch.

6. Other doc news:
Our next monthly Google Hangout is scheduled for March 26 at 21:00 UTC. The
first 10 to join get voice, and anyone can participate as a live audience
with chat enabled.

The Design Summit submission site is now active at
http://summit.openstack.org/.  I've created placeholders for two topics
we'll want to discuss to plan for Juno: Install guides and continuous
publishing and automation for the docs site. We should have room for at
least three more proposals and our timeslots are Wed-Friday. I know there
will be a proposal about making docs onboarding easier as well. I'm sure we
can come up with an API docs topic too.  Looking forward to it!

Nathan Kinder is working on bringing all the OpenStack Security Notes to
life in a github repo to be organized under the Documentation program.
https://review.openstack.org/#/c/73157/ The plan is to then publish the
Security Notes in a collection as an Appendix in the OpenStack Security

On April 16, the APAC OpenStack docs writers will hold a face-to-face
meeting. Check out the latest docs team meeting for details or contact Lana
Brindley. [4]

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20140321/8ce8a811/attachment.html>

More information about the OpenStack-dev mailing list