Hosting our Sphinx docs on apache.org

[Leif Hedstrom <zw...@apache.org>]

Hi,

we've started moving all our docs into a Sphinx format, and currently it's being hosted on Readthedocs.com. I think this would be much better served out of Apache infrastructure, and I was hoping we could get the ball rolling on this asap

 I don't know how much effort is evolved, but a a minimum we need automated docs updates (ideally triggered from git commits) and support for multiple versions of the docs (from our git branches, so easily managed). I'd be willing to help out with what I can, and perhaps our more skilled ATS Sphinx people can assist as well.

Any thoughts? I believe the toolchain from Readthedocs is open source, but getting something going shouldn't be too hard (last famous words…). This content would be cacheable, and we'd be happy to provide help there :).

Thanks!

-- Leif

Re: Hosting our Sphinx docs on apache.org

[Igor Galić <i....@brainsware.org>]

I'm almost surprised Leif didn't volunteer me to help out with this, so I guess I should do it formally myself ;)

Leif Hedstrom <zw...@apache.org> wrote:
>Hi,
>
>we've started moving all our docs into a Sphinx format, and currently
>it's being hosted on Readthedocs.com. I think this would be much better
>served out of Apache infrastructure, and I was hoping we could get the
>ball rolling on this asap
>
>I don't know how much effort is evolved, but a a minimum we need
>automated docs updates (ideally triggered from git commits) and support
>for multiple versions of the docs (from our git branches, so easily
>managed). I'd be willing to help out with what I can, and perhaps our
>more skilled ATS Sphinx people can assist as well.
>
>Any thoughts? I believe the toolchain from Readthedocs is open source,
>but getting something going shouldn't be too hard (last famous words…).
>This content would be cacheable, and we'd be happy to provide help
>there :).
>
>Thanks!
>
>-- Leif

-- 
Sent from my phone. Please excuse my brevity.

Re: Hosting our Sphinx docs on apache.org

[Leif Hedstrom <zw...@apache.org>]

On Sep 26, 2013, at 1:27 PM, Leif Hedstrom <zw...@apache.org> wrote:

> Hi,
> 
> we've started moving all our docs into a Sphinx format, and currently it's being hosted on Readthedocs.com. I think this would be much better served out of Apache infrastructure, and I was hoping we could get the ball rolling on this asap


Argh, that came out wrong: The Sphinx source is hosted on the regular apache.org Git server, it's part of the main Traffic Server git repo. What is hosted on Readthedocs.org is the HTML formatted output of running Sphinx on the source. This is what I'm hoping we could move into ASF owned infrastructure, and give a URL like e.g. http://docs.trafficserver.apache.org/.

Thanks!

-- Leif