Hi Massimo and all,

I'd like to lend a hand with the documentation project.


Based on reading all of the comments, I'm with Yarko and Paul Eden on
the direction we should take. Which is:

(1) A reST/Sphinx code repository, under source control, for a
community-based manual

(2) A wiki for organically generating new content, keeping up to date,
and for comments/additions to the manual
   (2.1) The wiki must be an external, already stable and fully-
featured Wiki. MoinMoin was suggested because it's Python-based. I
second this suggestion, especially since it has a reST plugin. Web2py
needs up-to-date documentation for all of its features right now. We
can't afford to wait until new Wiki software is developed.
   (2.2) The wiki can be replaced with a web2py-native version ONLY
once that version is stable and feature-complete.

(3) The reSt/Sphinx repository should be the new, up-to-date *manual*.
Once new additions to web2py get stable in the wiki, they are removed
from the wiki and moved to the manual (this is easy because they're
both written in reST). From that point onward, the Wiki page becomes a
_comment_ page attached to the official manual page, where people can
post examples, questions, etc.
   (3.1) Over time, comments, questions and answers can be back-ported
into the official manual and then deleted from the wiki.

In this way we can get the best of both worlds--fast documentation and
keeping up to date, plus a well-organized and indexed official manual.

--Jonathan

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"web2py Web Framework" group.
To post to this group, send email to web2py@googlegroups.com
To unsubscribe from this group, send email to 
web2py+unsubscr...@googlegroups.com
For more options, visit this group at 
http://groups.google.com/group/web2py?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to