[ckan-dev] Readthedocs and CKAN documentation versions

Sean Hammond sean.hammond at okfn.org
Fri May 10 12:11:18 UTC 2013


> Would mapping the release branches, rather than tags, to RTD docs
> versions work better? That way, as soon as we branch for a release,
> the docs for that release appear on RTD. Then all we need to do, is make
> sure it says "beta" somewhere prominent in the docs, until we decide
> that the release is final.
> 
> This would mean URLs to old CKAN 1.x releases would change, they'd now
> be /en/release-v1.8 instead of /en/ckan-1.8. I think we could get RTD to
> still build the docs for the ckan-1.8 tag but build them "privately", so
> ckan-1.8 wouldn't appear in the list of versions at the bottom of the
> page (only release-v1.8 would) but any links out there to /en/ckan-1.8
> would still work.

If no one objects to this, I'm going to go ahead and try publicly
building all the release-v* branches on RTD, and changing all the ckan-*
tags to being built privately. I'll wait until a week or two after 2.0
has been released to try this though, to avoid any untimely disruption.




More information about the ckan-dev mailing list