Break out docs into own repo

[jblaine]

I suggested this when the Great Github Move happened. I recall agreement that it was a good idea.

Either it got forgotten, is yet to be done but planned, or was decided not to be done.

This issue is for that.

[mleinart]

It was attempted but we weren't able to get the build on readthedocs.org to work with the custom install location - the import of functions.py for the functions doc generation depends on the virtualenv used to build the docs being able to import it and the install fails (due to /opt/graphite not being writable).

Definitely still something we want to do, it's just going to have to wait until we either decide to stop installing in /opt/graphite by default (possible but not yet discussed) or come up with a patch for readthedocs to allow the appropriate options to be passed to pip/setup.py

[obfuscurity]

I'd still like to see this happen but I'm not sure who's willing to take this on. /cc @esc @brutasse @gwaldo.

[gwaldo]

I think it's a great idea, but surprise, there be yaks.

From my perspective, the layers are:

• Get rst / sphinx working on my box; I'd had this working when I contributed some docs stuff to MongoDB, but it has since gone sideways. When I get this done, I've got a pull request to fill in some initial blank spots just about ready, but without Sphinx working, I can't test.
• Finish the work to migrate info in wikidot to the RTD site, so we can kill wikidot. Decommission wikidot site graphite-project.github.io#4
• Breakout (this ticket Break out docs into own repo #46)
• Start incorporating some of the tribal knowledge / wiki posts into the docs.

[obfuscurity]

I'd also still love to see this happen. There are few docs experts among the core team so I'm not optimistic this will happen before 1.0.0, but I'm holding out hope for the next release after.

[piotr1212]

the install fails (due to /opt/graphite not being writable).

#2409

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.