On Thu, Jun 6, 2013 at 7:02 PM, Alan Cabrera <[email protected]> wrote: > On Jun 3, 2013, at 2:36 PM, Greg Stein <[email protected]> wrote: >... >> The only question here, I believe, is whether we want to ship >> documentation, or just refer people to our website. If we want to ship >> docco, then it would go into trunk/. (and possibly incorporated >> somehow into site/ by the tooling) > > I think that the Sphinx-licious docs should be on our website, read-the-docs, > and delivered bundled in with the code so that consumers can generate their > own Sphinx-licious docs.
Okay. Sounds like we want trunk/docs/, and we'll ship those and generate them to steve/site/ as appropriate. >> Note that steve.apache.org must be static (all sites at the ASF must >> be static). We won't be allowed to use gunicorn, or similar. > > Sorry, I should have been more specific. > > By website I meant the voting website that's in this project. I thought that > the release Ah. Gotcha. Right now, we have a perl CGI script to deal with the voting. And some Apache HTTPd config bits. The CGI scripts basically invoke the cmdline tools to make the work happen. This is because we need the setuid bits on those tools. I suspect that we can simply use wsgiref rather than needing to haul in a gunicorn dependency. Structuring around wsgi means we could then provide (via wiki? docs?) instructions for gunicorn, mod_wsgi, etc. (and yes, the above implies rewriting the .pl CGI script into a wsgi app) > cadences of both may be different and the way I'm used to delivering Python > code is that command line and library code gets shipped together, like boto, > and gunicorn websites get their own project. If there's a clean way to ship > both together then I'm eager to see how. The project is small. I'd suggest keeping everything in trunk/. We can create a "dist.sh" to build distribution tarballs, pypi uploads, etc. In the future, we can have dist.sh build multiple distros as needed. But really: we're talking about a dozen scripts, some docco, and another dozen misc files. Multiple distributions is probably harder than needed. (I believe pypi install will be the #1 delivery, and we likely want to match expectations there) > The project website, I agree, should be somewhat static though I imagine it > will include Sphinx-licious docs. Right. Generate docs via Sphinx, and commit them to svn. svnpubsub will then publish that to the website. Cheers, -g
