- About Scala
- Documentation
- Code Examples
- Software
- Scala Developers
Scala International Documentation Spree #2 - 2011-09-17
Thu, 2011-09-08, 00:30
The date of the 2nd Scala International Documentation Spree is approaching. It will be run on Saturday the 17th of September (2011-09-17), from 10:00 UTC until 02:00 UTC on Sunday the 18th of September, 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.
--- Additional Information ---
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 Scala.
Changes to the Scaladoc comments should be offered as github pull requests from a clean branch to https://github.com/scala/scala . We 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 and Typesafe community liason Joshua Suereth.
Additional event details:- All information pertaining to the event will be put on the scala-lang wiki here:https://wiki.scala-lang.org/display/SW/Monthly+Scala+Docspree - 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! A particularly helpful task that people can do without committing too much time is reviewing documentation. This is just as important as writing the documentation itself!
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 15th of October 2011 (2011-10-15), 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.miller@epfl.ch).Iain McGinniss
--- Additional Information ---
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 Scala.
Changes to the Scaladoc comments should be offered as github pull requests from a clean branch to https://github.com/scala/scala . We 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 and Typesafe community liason Joshua Suereth.
Additional event details:- All information pertaining to the event will be put on the scala-lang wiki here:https://wiki.scala-lang.org/display/SW/Monthly+Scala+Docspree - 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! A particularly helpful task that people can do without committing too much time is reviewing documentation. This is just as important as writing the documentation itself!
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 15th of October 2011 (2011-10-15), 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.miller@epfl.ch).Iain McGinniss
