Offer staged content and link to built docs for reviews
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!
summary: |
- Offer link to built docs for reviews + Offer staged content and link to built docs for reviews |
Changed in openstack-ci: | |
milestone: | folsom → grizzly |
The same thing would honestly be nice for proposed gerrit changes, but would probably be more work.