[Openstack-docs] What's Up Doc? Oct 17th 2013

Summer Long slong at redhat.com
Fri Oct 18 07:04:38 UTC 2013


Hi Anne,
First off, congratulations on the Havana release with yourself as program technical lead! You were tireless and patient, you herded the cats, and it all somehow worked. For myself, as a newcomer to upstream contribution, the entire process was fascinating and educational.

And now, a question for the OpenStack Docs site.
Is there anyway to re-index the search, so that it gives out Havana results instead of Grizzly doc results?

thanks,
Summer

-- 
Summer Long 
OpenStack Documentation Lead 
Engineering Content Services 

Red Hat Asia Pacific 
Brisbane, Austral ia 
slong at redhat.com | irc: slong 

----- Original Message -----
From: "Anne Gentle" <anne at openstack.org>
To: openstack-docs at lists.openstack.org, "OpenStack Development Mailing List" <openstack-dev at lists.openstack.org>
Cc: "Glen Campbell" <glen.campbell at rackspace.com>
Sent: Friday, October 18, 2013 6:13:45 AM
Subject: [Openstack-docs] What's Up Doc? Oct 17th 2013

Special release day edition of What's Up Doc -- I want to take a minute to recognize this milestone and give a huge thanks to everyone who made it possible to release docs today. A sincere thank you, pat on the back, and special recognition to the top 10: 
Andreas Jaeger, Diane Fleming, (me), Tom Fifield, Christian Berendt, Sean Roberts, Stephen Gordon, Summer Long, Lorin Hochstein, and Nermina Miller. Way to rock the docs! 

The openstack-manuals repo now has a stable/havana branch which publishes the Install Guides and Configuration Reference to docs.openstack.org/havana/ . All other guides publish from the master branch to a direct link. 

So, I'll walk through a scenario. Let's say you have a fix to the install guide that you know is incorrect in the Havana link for the install guide: 


    1. First, fix the error in the master branch as normal. 
    2. Then, once that patch is reviewed and merged, follow the steps in https://wiki.openstack.org/wiki/Documentation/HowTo#How_to_a_cherry-pick_a_change_to_a_stable_branch to pick a copy of that patch create a special patch just for the stable/havana branch. 
    3. Once that patch is merged, your changes will show up on the docs.openstack.org/havana/ version of the install guide. 
Hint: It's best to keep those changes small to make the reviewing/merging when backporting easier. 

For the time prior to the summit, let's focus on doc bugs -- triaging, fixing, tagging, all are good tasks for the next 2 weeks. Let's also keep an eye on http://ask.openstack.org and the Disqus comments for feedback and input. I also want to work on search-ability/find-ability with a sitemap.xml, fine-tuned .htaccess, and any other tips and tricks after the release and reorg would be welcomed. We're also exploring redesign ideas for the docs pages. After the Summit and listening to feedback on Havana, let's write up some top priorities for docs for the next release. 

Thanks all, 
Anne 

_______________________________________________
Openstack-docs mailing list
Openstack-docs at lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs



More information about the Openstack-docs mailing list