[openstack-dev] What's Up Doc? July 2, 2014

Anne Gentle anne at openstack.org
Wed Jul 2 18:37:04 UTC 2014


The doc team met this week for the APAC time zone.
Minutes:
http://eavesdrop.openstack.org/meetings/docteam/2014/docteam.2014-07-02-03.06.html
Log:
http://eavesdrop.openstack.org/meetings/docteam/2014/docteam.2014-07-02-03.06.log.html

__In review and merged this past week__

The security guide has been removed from the openstack-manuals repo and
moved to the security-doc repo.

The docs-specs repository is now active at
https://github.com/openstack/docs-specs. I'd like to see these three specs
written for Juno for docs:

* https://blueprints
.launchpad.net/openstack-manuals/+spec/python-client-docs-for-app-devs I
requested more discussion on exactly what work should be done. Tom, do you
have time to write a spec? If not you, who is interested?

* https://blueprints
.launchpad.net/openstack-manuals/+spec/redesign-docs-site I plan to write a
spec this once we get a web design plan laid out in more detail.

* https://blueprints.launchpad.net/openstack-manuals/+spec/heat-templates We've
discussed a lot on the ML but it doesn't have a linked wiki page and could
use further description and decisions. Gauvain, could you write a spec
based on what we've discussed so far?

*
https://blueprints.launchpad.net/openstack-manuals/+spec/create-networking-guide
We've
got a lot of interest in this new book -- Lana's talking about a doc swarm
around it, and Phil Hopkins and Matt Kassawara know this area. Matt or
Phil, up for a doc spec for this one?

Training team, do you have "must have" specs to write?

I think the review team for docs-specs can be as small as:
Anne Gentle
Sean Roberts
Andreas Jaeger
Bryan Payne
or as large as docs-core. Projects are going either way with it. Our setup
is a separate team, but we can populate as we need.

Any input on docs-specs? Please let us know.

__High priority doc work__

I've been fielding questions about good areas to work in the docs. I'd like
these to be high priority:
- Networking in admin guide and the separate guide that needs to have a
spec written
- Identity, especially v2 vs. v3 in the admin and ops docs
- Orchestration templates: reference inclusion and how-to information
integrated in admin user guide

__Ongoing doc work__

We're reconsidering the priorities for web design work -- whether
docs.openstack.org or developer.openstack.org needs the overhaul. So stay
tuned as we work with the Foundation on the pre-work and planning.

__New incoming doc requests__

None this week.

__Doc tools updates__

Once this patch to oslosphinx merges, project indicate if they're
incubating with a change to your sphinx conf.py, setting html_theme_options
equal to {'incubating': True}'.
https://review.openstack.org/#/c/103935/
Thanks to Graham Hayes for that! The projects that need to set it when it's
available are:
-Designate
-Ironic
-Sahara
-Barbican
-Marconi

The latest version of openstack-doc-tools is 1.16.1 and has the latest
RelaxNG schema included.

__Other doc news__

 Still working on the naming for glance-provided services. Thierry noted
today that the mission can evolve without the program name changing yet in
https://review.openstack.org/#/c/98002/. So we hope to keep looking for the
right wording as the evolution happens.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20140702/9d51e559/attachment.html>


More information about the OpenStack-dev mailing list