On Mon, Nov 29, 2010 at 8:05 AM, BrianTheLion <[email protected]> wrote: > A little background: I started writing an essay the other day about > end-to-end functional encapsulation in the pylons and pyramid > contexts. It quickly got quite long and didn't seem appropriate for > the mailing list. Still, I thought it could be a nice contribution to > the community if I could get it reviewed and made visible. That made > me think that the project was sorely lacking a formalism by which > anybody can contribute structured, forward-thinking documentation.
I'm building a collection of essays and tutorials here under "Pyramid Supplemental Docs". http://bytebucket.org/sluggo/pyramid-docs/wiki/html/index.html http://bitbucket.org/sluggo/pyramid-docs I can make you contributor if you want and you can upload your own stuff. Then it'll be there and visible and can be considered for the official docs whenever they're revised. Plus it's hg rather than git, for those like me who still aren't fully comfortable with git. > We could have a repository of essays (maybe all in > wikitext format, say) that folks can clone, add to, and submit pull > requests to. Pull requests will be accepted only when the essays seem > like they are up to snuff, and the issue tracker could be used for > moderating. Sphinx format is compatible with the Pyramid docs and an increasing number of packages that are used with Pyramid. Wiki formats are unique to each wiki, and require major transformation to convert to Sphinx. I don't think we need pull request approval as much as vetting the authors: make sure they can write documentation clearly and have a general understanding of the subject, and then the author can note the essay's status himself (e.g.., in an "unfinished" section, "untested", [i.e. not peer reviewed] etc.) -- Mike Orr <[email protected]> -- You received this message because you are subscribed to the Google Groups "pylons-discuss" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/pylons-discuss?hl=en.
