Re: [Jython-users] Jython documentation

[Ben H. <ben...@fi...>]

Well, I am pleased so so many people are interested and willing to 
contribute to improving the Jython documentation.

I think finding a home is the first step, and I would definitely prefer 
it to be integrated with the jython development site at sourceforge.

1. Add a Docs tab to the jython project page and authorize some 
interested people to check in docs to CVS. This has the advantage of 
very tight integration with the Jython development project. Having a 
small team of maintainers may make the resulting documents more coherent 
and organized. The disadvantage is that the people maintaining the docs 
have to be responsive and attentive to other's contributions, and it 
needs to be easy for everybody to suggest changes and or additions.

2. Use the Wiki idea as proposed by Brian, copied below. This very open 
design means that everybody can add and update material easily. This is 
often a good thing, but I do have some concerns:
    * With multiple independent authors, the docs may become a little 
scattered and divergent in their coverage and format, making it hard for 
people to navigate and possibly compromising their accuracy.
    * I hope Wiki has some backup or versioning system. What protection 
exists against accidental or deliberate deletion of material?

(Possibly, we could start with Wiki to gather material easily, then 
collate it together, check it for errors, and transfer it to the jython 
project)

Either way, the docs should be reviewed by, and have the support of, the 
core Jython developers. IMO, ideally this means Finn Bock, because he 
would seem to be best qualified to ensure their accuracy.

Does anybody want to propose other home candidates, or indicate an 
preference for one of the above?
Brian, can you comment on versioning and backup protection for Wiki?

Regards
Ben

Brian Zhou wrote:

Would suggest hosting a wiki site on jython.org.

See http://jywiki.sourceforge.net/index.php?WikiWikiWeb for some pointers
explaining the wiki idea. Good thing about wiki is everybody can easily
participate and share, the pages are automatically indexed; downside is that
it's not as systematically organized.

I put out a few page starting at
http://jywiki.sourceforge.net/index.php?JythonServlet focusing on jython
servlet, but don't have a lot of time adding things to it. Feel free to add
pages from here http://jywiki.sourceforge.net/index.php?AddingPages