[Openstack-docs] What's Up Doc? Special Summit Edition Nov 5 2013

Diane Fleming diane.fleming at RACKSPACE.COM
Tue Nov 5 14:10:10 UTC 2013


Great summary!

As for Cli reference, what about doing what we do for API ref? Just a web page with list of calls and ref info? There really isn't enough info for a book (I think).

As for horizon screenshots, do we need them? That GUI is not that complicated and screenshots are a pain to maintain (automated or not).  A better project might be to add some online help to the GUI itself?

Thanks Anne (and all)!

Sent from my iPhone

On Nov 5, 2013, at 3:25 AM, "Anne Gentle" <anne at openstack.org<mailto:anne at openstack.org>> wrote:

Hi all,
The first four docs discussions are done and we've got some decisions we want to bring to the group. Ideally these decisions will stick for the Icehouse time frame, the next six months. Tom, Summer, Stephen, and I were here but we want to be sure we came to the same conclusions on our own that our larger group would have as well.

Doc automation:
- We want to set up a doctools repo just for doc tools like the automation tools and gate tests. Should help with translation tools also. Open to ITS use.
- Config items automation - Oslo will likely change enough this release that our tool needs to change as well.
- CLI reference automation - part of the restructure discussion uncovered a need to streamline the Config ref to reference only, and also create a CLI reference for CLI reference only. We want to prioritize automating this as highly as config automation.
- API doc automation - still under discussion, stay tuned after this Friday.
- RST to XML workflow for training guides - Sean wants to filter the dev doc further.
- Ceilometer has tables they auto-generate in their dev docs that they want to bring into openstack-manuals.
- Horizon workflows: Summer had a great idea to automate screen captures of common workflows in the dashboard. This work would be great to do in the coming release, Summer is going to do a research spike into tooling.

Restructure:
Despite the tradeoff that we have to re-communicate some more moves to all the teams, we want to trim the configuration reference down to just listings of options, no how-to or explanatory information. Move this type of info to the Cloud Admin Guide. Are we good with this plan for Icehouse?
Pull out CLI reference info from the end-user guide and admin user guide, put into a CLI reference that goes to the submenu level. Sound good?

Install guide (always seems to be a topic of its own):
- Continue with current guide, maintain and update for icehouse.
- Look for 2-3 more resources to help with install guides.
- Push for a real big testing drive a month before release instead of 2 weeks.

Any questions? If you're not here, we sure wish you were here!

As a side note, here are some pics from our women of OpenStack boat outing last night on the harbor. The grey fog was everywhere and we couldn't go on deck it was just too wet. But the buildings lighting up are amazing here, you can hardly capture the sights in photos.
http://flic.kr/s/aHsjLUoHM2

Here's the one sightseeing day I've had so far, going on a "crystal bottom" cable car ride to get to a big Buddha statue with a monastery nearby.
http://flic.kr/s/aHsjLWowHf

Anne
_______________________________________________
Openstack-docs mailing list
Openstack-docs at lists.openstack.org<mailto:Openstack-docs at lists.openstack.org>
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20131105/42311408/attachment.html>


More information about the Openstack-docs mailing list