This page is no longer maintained — Please continue to the home page at www.scala-lang.org

Is colladoc supposed to be down?

7 replies
Yuvi Masory
Joined: 2010-12-22,
User offline. Last seen 1 year 27 weeks ago.
Hi,
I'd like to contribute documentation and was referred to collaborative-scaladoc, but it's down: http://scala-webapps.epfl.ch/colladoc/ Should documentation still be contributed via Trac + patch attachments?

Yuvi

Antonio Cunei
Joined: 2008-12-16,
User offline. Last seen 3 years 22 weeks ago.
Re: Is colladoc supposed to be down?

On 10/03/2011 22:23, Yuvi Masory wrote:
> Hi,
>
> I'd like to contribute documentation and was referred to
> collaborative-scaladoc, but it's down:

Up again now, thanks.
Toni

Yuvi Masory
Joined: 2010-12-22,
User offline. Last seen 1 year 27 weeks ago.
Re: Is colladoc supposed to be down?
Hi Toni,
Thanks for getting it back up.Can the scala.nsc classes be added too? I'm mostly interested in documenting the compiler.

Yuvi



On Fri, Mar 11, 2011 at 11:35 AM, Antonio Cunei <antonio [dot] cunei [at] epfl [dot] ch> wrote:
On 10/03/2011 22:23, Yuvi Masory wrote:
Hi,

I'd like to contribute documentation and was referred to
collaborative-scaladoc, but it's down:

Up again now, thanks.
Toni

Pedro Furlanetto
Joined: 2009-08-19,
User offline. Last seen 2 years 34 weeks ago.
Re: Is colladoc supposed to be down?

+1. It would be great!

On Fri, Mar 11, 2011 at 9:16 PM, Yuvi Masory wrote:
> Hi Toni,
> Thanks for getting it back up.
> Can the scala.nsc classes be added too? I'm mostly interested in documenting
> the compiler.
>
> Yuvi
>
>
>
> On Fri, Mar 11, 2011 at 11:35 AM, Antonio Cunei
> wrote:
>>
>> On 10/03/2011 22:23, Yuvi Masory wrote:
>>>
>>> Hi,
>>>
>>> I'd like to contribute documentation and was referred to
>>> collaborative-scaladoc, but it's down:
>>
>> Up again now, thanks.
>> Toni
>>
>> --
>> Antonio Cunei
>> Scala Team, EPFL
>
>

Antonio Cunei
Joined: 2008-12-16,
User offline. Last seen 3 years 22 weeks ago.
Re: Is colladoc supposed to be down?

The situation concerning the maintenance of Colladoc is a bit fuzzy. The
project was developed as part of the Google Summer of Code by Petr
Hosek; he was mentored by Gilles Dubochet, a PhD student here at EPFL.

Gilles has now completed his PhD; he is currently on hiatus in India,
and his work at EPFL is done. I do not know whether Petr Hosek is still
working on the project. The website of the project is at:

http://code.google.com/p/collaborative-scaladoc/

Concerning the installation of Colladoc at EPFL, available at
http://scala-webapps.epfl.ch/colladoc, I believe that it was set up by
Gilles a while back, and that it was managed by him. I know where the
instance lives, but I don't know how it operates.

Gilles will be back in a couple of weeks; when he's back we'll ask him
details about the local installation, in order to hand responsibility of
the tool over to a new person.

We will have new PhD students starting work in the next coming months;
we already discussed the matter, and one of them will be assigned
responsibility of both Scaladoc and Colladoc for the future.

Toni

petrh
Joined: 2011-03-15,
User offline. Last seen 1 year 32 weeks ago.
Re: Is colladoc supposed to be down?
Sorry for late response, I have not been subscribed to the scala-tools list and found this message by accident. The official website has changed and is now available at:
http://collaborative-scaladoc.github.com/

This was related with source hosting change to GitHub to ease the job for potential contributors. The project need any helping hand and I would be really happy to see more contributors coming around - we have a long list of ideas flying around which waits to be implemented. However, it is impossible to keep up the development with just one developer working on it in his free time (me), so we definitely need more people to work on the project if this should succeed.
Right now, I am not actively working on the development myself as I have started my PhD (not on Scala though) and I am extremely busy with my research. However, I am still trying to push the project forward. That is why I have proposed an MSc Group Project here at Imperial College extending Colladoc with full-text search capabilities (like Hoogle on steroids).
This project has selected by one of the student groups and they did a tremendous job. The project is almost finished now - students are now finishing documentation and final presentation will take place next week. The source code should be released within few days and this new version would be hopefully deployed to http://scala-webapps.epfl.ch/colladoc/.
Together with Gilles, we have also prepared list of tasks for the future Colladoc development and I have promised to help supervising any student which will pick up Colladoc for this years Google Summer of Code - so lets hope there will be one.
Expect to hear more about Colladoc in the upcoming weeks, I really hope that we would manage to resuscitate the project again although it was never really dead - just sleeping for a while.
Petr
Yuvi Masory
Joined: 2010-12-22,
User offline. Last seen 1 year 27 weeks ago.
Re: Is colladoc supposed to be down?
Hi,
What is currently happening to contributions submitted via the colladoc system? It was pointed out that large documentation projects should not be started on colladoc, but is there a purpose to submitting any documentation at all or is it all destined for /dev/null :) ?

Yuvi



On Tue, Mar 15, 2011 at 12:13 PM, Petr Hosek <petrhosek [at] gmail [dot] com> wrote:
Sorry for late response, I have not been subscribed to the scala-tools list and found this message by accident. The official website has changed and is now available at:
http://collaborative-scaladoc.github.com/

This was related with source hosting change to GitHub to ease the job for potential contributors. The project need any helping hand and I would be really happy to see more contributors coming around - we have a long list of ideas flying around which waits to be implemented. However, it is impossible to keep up the development with just one developer working on it in his free time (me), so we definitely need more people to work on the project if this should succeed.
Right now, I am not actively working on the development myself as I have started my PhD (not on Scala though) and I am extremely busy with my research. However, I am still trying to push the project forward. That is why I have proposed an MSc Group Project here at Imperial College extending Colladoc with full-text search capabilities (like Hoogle on steroids).
This project has selected by one of the student groups and they did a tremendous job. The project is almost finished now - students are now finishing documentation and final presentation will take place next week. The source code should be released within few days and this new version would be hopefully deployed to http://scala-webapps.epfl.ch/colladoc/.
Together with Gilles, we have also prepared list of tasks for the future Colladoc development and I have promised to help supervising any student which will pick up Colladoc for this years Google Summer of Code - so lets hope there will be one.
Expect to hear more about Colladoc in the upcoming weeks, I really hope that we would manage to resuscitate the project again although it was never really dead - just sleeping for a while.
Petr

petrh
Joined: 2011-03-15,
User offline. Last seen 1 year 32 weeks ago.
Re: Is colladoc supposed to be down?
The comments contributed to Colladoc are internally stored into database. From there, anyone can export them (using export functionality in application) and then, they need to applied to sources using Mergedoc. This was done by Gilles in the past, but as long as Gilles has now finished his PhD, I am not sure who will be responsible for this in the future. In all cases, you contributions are definitely not lost (as long we will not loose the internal database).
Petr

Copyright © 2012 École Polytechnique Fédérale de Lausanne (EPFL), Lausanne, Switzerland