On 08/14/2013 04:17 PM, Anne Gentle wrote: > 5. Doc tools updates: > > The Maven plugin that builds our docs is sourced at > https://github.com/rackerlabs/clouddocs-maven-plugin and just released > version 1.9.0. > > Our pom.xml files still point to 1.8.0 but we could start testing 1.9.0 > which adds supports for olinks. By using olinks instead of our current > linking with xrefs would prevent Oxygen from showing non-valid file > warnings in individual chapter files and adds an easier interface for > finding cross-reference links. David Cramer can demo at the Boot Camp, > and then we'll need to make decisions about how much cross-referencing > we want. With fewer books going to a "released" docs site, we may want > to limit the use of cross-references altogether, but let's discuss in > person. Our current linking conventions are > here: https://wiki.openstack.org/wiki/Documentation/Conventions#Linking. > > Another addition for 1.9.0 is adding parameter style and type to the > http://api.openstack.org/api_ref.html page. Review for testing at > https://review.openstack.org/42011. To use olinks, you'll also need to add the olink-maven-plugin to your pom. I plan to update one OpenStack doc to serve as a working example of how it all fits together. Also, I can demo it at the Boot Camp: https://github.com/rackerlabs/olink-maven-plugin David