Re: [Jython-users] Jython documentation

[Brian Z. <bri...@ya...>]

>
> (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)
>

I like this idea.

In terms of backup or versioning support, it varies a lot depending on
different wiki implementations:

  * I hope jywiki is up to the task but it's not there yet, not to
mention the fact that sourceforge.net does not host java servlet.
Actually jywiki is very close to the original wiki.
  * PhpWiki is probably a better choice since it got 90% of the features
without being large, supports page locking, simple diff and various
storage interfaces (plain text, mysql, etc). Sourceforge.net provides
PHP hosting, MySql database and cron job - so we can either backup the
MySql database or check plain text pages into CVS.
  * I've also looked at MoinMoin before. My impression was that it got
way too many features than you need, and the design was not very
coherent or wabi-sabi.

Regards,

-Brian

----- Original Message -----
From: "Ben Hutchison" <ben...@fi...>
To: "jython-users" <jyt...@li...>
Sent: Friday, May 25, 2001 3:35 AM
Subject: Re: [Jython-users] Jython documentation


> 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?
>

> 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