Re: [scala] Colladoc 1.0 Beta 1 Announcement
Petr Hosek <mail@...
2010-08-14 02:59:38 GMT
Actually, I was originally planning to include such feature which would
allow to remove changes to comments already to second beta. Problem is
that when you introduce such functionality, you also need to provide
some kind of moderation, at least separation to normal and super users.
Therefore, I have decided to postpone this feature and implement it as a
part of the next release (beta/release candidate/whatever this version
will be). I cannot give you exact timeframe when this will be available
as the timeplan for future development has not yet been set, but I will
definitely keep you informed.
On Fri, 2010-08-13 at 20:36 +1000, Tony Morris wrote:
> Hello Petr,
> Is it intended that the full 1.0 version will guarantee retention of edits?
> Petr Hosek wrote:
> > Hello to everyone in the Scala community,
> > I would like to announce the public availability of the first beta of
> > Colladoc, the collaborative/wiki version of Scaladoc. You can try it
> > online at http://scala-webapps.epfl.ch/colladoc/ for the Scala
> > standard library.
> > Visit the project's web site
> > <http://code.google.com/p/collaborative-scaladoc/> for usage
> > instructions or to download a version of Colladoc that you can run on
> > your own sources.
> > Colladoc explores the possibility of using social collaboration for
> > documenting Scala code. The application is based upon Scaladoc 2,
> > which has been converted into a Lift web application. The application
> > allows online editing of comments, which updated versions are stored
> > on the server. To prevent vandalism, Colladoc implements simple user
> > management and authentication, which will be expended in the future.
> > If required, updated comments can be exported to the format used by
> > the scaladoc-merge tool (install it into Eclipse from this
> > <http://lamp.epfl.ch/%7Edubochet/MergePluginUpdateSite/> update site
> > <http://lamp.epfl.ch/%7Edubochet/MergePluginUpdateSite/>) and merged
> > into source code.
> > Be advised: whilst I encourage you to edit comments on the online
> > version of Colladoc <http://scala-webapps.epfl.ch/colladoc/>, I cannot
> > guarantee that your changes will be kept. Your changes will be stored
> > and we will do our best to apply them to the Scala library source. But
> > this being a beta, they may also get lost; it is probably unwise to do
> > large scale documentation work on Colladoc right now.
> > You can find known issues on Colladoc’s issue tracker
> > <http://code.google.com/p/collaborative-scaladoc/issues/list>. If you
> > discover an issue that is not listed, please report it using the tracker.
> > I would be very pleased to answer any of your questions regarding the
> > application and its future development.
> > Best regards,
> > Petr Hosek