Offer staged content and link to built docs for reviews

Bug #968781 reported by Anne Gentle
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Core Infrastructure
Fix Released
Medium
Clark Boylan

Bug Description

This could get a little complex for large reviews, but I'd like to make doc reviews easier than comparing XML line-by-line, though still offering the XML, RST, markdown side-by-side comparison.

I want to get Jenkins to build docs, copy to a staging area, then put in HTML links to generated files that changed based on the doc review submission. The last part sounds tough to me but maybe it's not.

Jenkins already builds the docs, and we have a docs staging web server setup, both these would help a bunch. The part that would be really valuable is the links to HTML files. Multiple HTML files are created along with a PDF - I would think the PDF would be too long to review easily, but would like a pointer for reviewers to know which HTML files they could look at, even if it's just a chapter pointer for starters. I can describe a walkthrough for a particular chapter if you like. I guess doc submitters could create the URL manually and put it into the commit message if they understand the system, but seems like it should be automatable.

Thanks for the assist!

Anne Gentle (annegentle)
summary: - Offer link to built docs for reviews
+ Offer staged content and link to built docs for reviews
Revision history for this message
Monty Taylor (mordred) wrote :

The same thing would honestly be nice for proposed gerrit changes, but would probably be more work.

Changed in openstack-ci:
milestone: none → folsom
status: New → Triaged
importance: Undecided → Medium
Monty Taylor (mordred)
Changed in openstack-ci:
milestone: folsom → grizzly
Revision history for this message
Clark Boylan (cboylan) wrote :

A docs-draft vhost has been added to static.openstack.org and documentation Jenkins jobs have been updated to copy their build contents to static.openstack.org when building jobs in the check pipeline. This makes documentation drafts available for reviewing at docs-draft.openstack.org.

Changed in openstack-ci:
assignee: nobody → Clark Boylan (cboylan)
status: Triaged → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers