The Monthly Scala Docspree is a new community-run event intended to expediate the process of creating high quality documentation for the Scala ecosystem. Our primary objectives are:
- Produce ScalaDoc documentation for the standard library, particularly for the parts of the standard library which are very frequently used (collections, for instance).
- Produce tutorial material to help people familiarise themselves with the language, perhaps with background specific documentation for programmers coming from Java, Python, Ruby, C++, etc.
- To get produced documentation into the nightly releases of Scala as soon as possible during or after the event.
If you want to participate and see your contributions make it into the main Scala distribution, this will be the quickest possible way!
The Docsprees will generally be run on the third Saturday of every month, unless otherwise indicated on this page. All contributors, of any level of experience with Scala, are welcome to participate. Even if you don't feel able to write documentation, you will be able to act as a reviewer for documentation that is produced to help ensure that it is of high quality.
The event will be run through IRC, using the ##scala-docspree channel on freenode (webchat link).
Documentation changes will be contributed through github, so please do familiarise yourself with git (tutorial, ref manual) before the event. There will of course be plenty of people participating in the event who can help you with any Git related queries, so don't worry about it.
There is some good information on the ScalaDoc Workflow page on how to work with ScalaDoc, and rebuild specific parts of the documentation when you want to see how your documentation will look when run through the ScalaDoc tool.
Docspree #3 - 2011-10-15
The second Scala Docspree will be run on the 15th of October, 2011. The event will begin at 10:00 UTC, and end at 02:00 UTC on the 15th of October. This is so that the full spectrum of time zones that have indicated interest, from UTC-8 to UTC+5, can participate. We expect that the Eurasian participants will be involved from 10:00 UTC to around 18:00 UTC, while the Americas will be involved from around 15:00 UTC to 02:00 UTC.
If you have any specific suggestions on places to document for this docspree, please add them to the Documentation Wishlist.
If you expect to attend this docspree, please add your name, time zone, and expected arrival / departure so the organisers have a rough idea when people will be around:
14:00 UTC ?
|19:00 UTC ?|
Docspree #2 - 2011-09-17
The second Scala Docspree was run on the 17th of September, 2011, with some ten to twelve people coming together to either review or produce new documentation for the API. Changes were made to the Scaladoc tool, so it is now possible to document the root package, while the continuations package, PagedSeq, parsing.combinator, compat.Platform were all improved, and are now in nightly. To all who participated- your efforts are very much appreciated by current and future users of the language!
Docspree #1 - 2011-08-20
The first Scala Docspree was ran on the 20th of August, 2011, with roughly a dozen participants from all over the world collaborating to enhance the scala documentation. Changes were made to better document the AnyVal hierarchy, scala.Predef, scala.sys.process, Stream and HashMap. Thanks to all who participated!