Only publish in tree documentation for releases

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

Bug Description

Prefix TL;DR Stop publishing changes to in tree documentation for the master branch to http://docs.openstack.org/developer/project, then only release documentation will be published. Also, have http://docs.openstack.org/developer/project contain the latest released changes (or redirect to them).

The IRC log below contains the thought process and justification for this change.

bcwaldon | mtaylor: I think its more valuable to see what matches latest pypi release
+mtaylor | bcwaldon: and have a master dir
+mtaylor | ?
bcwaldon | sure
+mtaylor | bcwaldon: or skip publishing master docs at all?
bcwaldon | mtaylor: master might not be useful
+mtaylor | ok
bcwaldon | mtaylor: since you cant get the client that matchthose docs without installing from source
+mtaylor | clarkb: ^^^
bcwaldon | mtaylor: pypi/packages are our main distro method here
+mtaylor | bcwaldon: +
+mtaylor | bcwaldon: ++
+mtaylor | good point, and I believe I agree with you
bcwaldon | excellent
bcwaldon | also, check out latest python-glanceclient docs
clarkb | ok, I need to run now, but will reconfigure the jobs so that only publishing actually pushes doc changes
bcwaldon | clarkb: thanks!
+mtaylor | clarkb: we should probably also think about how to have the most recent thing that was published to root get moved to its tag when a new tag is made
+mtaylor | bcwaldon: NICE
bcwaldon | mtaylor: why thank you, I think thats infinitely more useful
bcwaldon | mtaylor: and i'm super excited about the release notes section
+mtaylor | bcwaldon: yes. it's a thing about which one should be excited!
clarkb | mtaylor a redirect in /index.html should work

Revision history for this message
James E. Blair (corvus) wrote :

Are we talking about just client, or client and server projects?

Revision history for this message
Thierry Carrez (ttx) wrote :

Hrm. Sounds like /developer/ documentation should by default match master, which is the development target... User documentation, OTOH, should match the last release.

I think the confusion comes from client tools, where user = developer ?

Revision history for this message
Anne Gentle (annegentle) wrote :

My current thinking is:
Swift always wanted a final released version of their Sphinx docs at swift.o.o/1.x.x but the other projects perceived dev docs more like "current state of code notes" - which is more what I believe that Python dev audience needs. Brian was a supporter of "only automated doc strings should be output from Sphinx docs" last Design Summit (April 2012). I believe it's best for Python dev docs to just publish latest (and keep an archive around of the released versions).

To me, glance client and other client docs should be treated as a frozen "released" version that the user audience can refer to based on their version. In fact I got a bit of feedback that the CLI docs get worse in between releases. So publishing "master" might be just frustrating users in this case.

Changed in openstack-ci:
status: New → In Progress
Monty Taylor (mordred)
Changed in openstack-ci:
milestone: none → folsom
importance: Undecided → Medium
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-ci-puppet (master)

Reviewed: https://review.openstack.org/13725
Committed: http://github.com/openstack/openstack-ci-puppet/commit/04fe922ae6f97f19e48137abcde453ecba14c43e
Submitter: Jenkins
Branch: master

commit 04fe922ae6f97f19e48137abcde453ecba14c43e
Author: Clark Boylan <email address hidden>
Date: Wed Sep 26 11:43:07 2012 -0700

    Publish python-*client docs only on releases.

    Modify the run-docs script to upload the latest tagged release docs to
    the root dir of a projects developer docs and to a dir for the tagged
    release. With this in place and the python-*client-docs jobs running
    only in the publish queue we will see documents at
    docs.openstack.org/developer that follow the latest releases for the
    client projects.

    Finally, re add the python-*client docs jobs as they were the projects
    that wanted this behavior in the first place.

    Fixes bug #1040251

    Change-Id: Ia3cf07d860b10214ed54fcf9748330866cb47f5d

Changed in openstack-ci:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.