- About Scala
- In the Enterprise
- Scala Community
- Language Research
- In the Press
- The Scala Team
- Scala's Prehistory
- Contact Us
- Learning Scala
- Tour of Scala
- Scala API
- Setup & Getting Started
- Programming Guides
- Other Guides
- Code Examples
- Scala Developers
Scala International Documentation Spree #1 - 2011-08-20
Fri, 2011-08-12, 20:36
I am pleased to announce that the first Scala Documentation Spree will
begin on the 20th of August 2011 (2011-08-20), at 10:00 UTC. The event
will run until 2011-08-21 at 02:00 UTC, in order to allow
participation across all time zones. This event will be run on the
third Saturday of every month for the forseeable future.
The purpose of this event is to bring the community together to
improve documentation of all kinds related to Scala. The quality of
the documentation is one of the most common complaints made about
Scala, so I believe that incremental improvement of both the Scaladoc
documentation and the collation of high quality tutorials and holistic
documentation will help greatly in encouraging more people to use
I believe there will be two "teams" involved in this docspree -
contributors from Eurasia, and contributors from the Americas. Team
Eurasia will likely be working from 10:00-20:00 UTC, while Team
America will likely be working from 16:00-02:00 UTC. I personally will
endeavour to be available for the entire duration of the event to help
coordinate activities, and you may email me at any time at
iainmcgin [at] gmail [dot] com.
Changes to the Scaladoc comments should be offered as github pull
requests to https://github.com/scala/scala . I also encourage such
changes to be reviewed by other participants, by directly commenting
on the pull request through github. Documentation which is reviewed
will hopefully be merged promptly with the help of documentation
tsaritsa Heather Miller.
Additional event details:
- All information pertaining to the event will be put on the
scala-lang wiki here:
- The event will be run over IRC, on the ##scala-docspree channel on
FreeNode. People with aligned interests should feel free to
communicate more directly using Skype or other tools as necessary.
- You are free to work on whatever documentation is of interest to
you. I am particularly interested in people writing scaladoc comments
for the standard library, but contributions to other open source Scala
projects and stand-alone tutorial material is of great benefit also.
- You can participate as much or as little as you like!
If you intend to participate in this docspree, please visit the
scala-lang wiki page above and add your name to the list of delegates.
The next documentation spree will be run on the 17th of September 2011
(2011-09-17), so if you can't make this event please consider
participating in the next one!
Finally, any questions or comments please do contact me, or Heather
Miller (heather [dot] miller [at] epfl [dot] ch).