- About Scala
- Documentation
- Code Examples
- Software
- Scala Developers
Monthly docspree & survey
Sat, 2011-11-26, 04:10
Hello everyone,
Firstly, apologies for my lack of involvement over the last two months. The level of attendance at the monthly docspree has been sliding to the point that it may not be worth running the events any more, so I wanted to issue a quick survey to try and get some feedback (entirely anonymous) on the event. It consists of five questions, and shouldn't take more than 10 minutes to complete:
https://docs.google.com/spreadsheet/viewform?hl=en_US&formkey=dC04TXM1UmNnblRNdTltRVBKc2pzd1E6MQ#gid=0
All feedback is welcome, and if you are comfortable making your comments publicly you can simply reply to this email, I'll take everything into account.
The plan was to run another docspree tomorrow, though I have left it kind of late to announce this and expect anyone to turn up. Regardless, if you're interested in writing some documentation (either scaladoc, or contributing to the new docs site) then email me and I'll make sure I'm available. I'll be hanging around in IRC from around 1800 UTC, at least for a few hours and if at least a few people show I'll be sticking around for most of the day.
Cheers,Iain
Firstly, apologies for my lack of involvement over the last two months. The level of attendance at the monthly docspree has been sliding to the point that it may not be worth running the events any more, so I wanted to issue a quick survey to try and get some feedback (entirely anonymous) on the event. It consists of five questions, and shouldn't take more than 10 minutes to complete:
https://docs.google.com/spreadsheet/viewform?hl=en_US&formkey=dC04TXM1UmNnblRNdTltRVBKc2pzd1E6MQ#gid=0
All feedback is welcome, and if you are comfortable making your comments publicly you can simply reply to this email, I'll take everything into account.
The plan was to run another docspree tomorrow, though I have left it kind of late to announce this and expect anyone to turn up. Regardless, if you're interested in writing some documentation (either scaladoc, or contributing to the new docs site) then email me and I'll make sure I'm available. I'll be hanging around in IRC from around 1800 UTC, at least for a few hours and if at least a few people show I'll be sticking around for most of the day.
Cheers,Iain
Sun, 2011-11-27, 11:27
#2
Re: Monthly docspree & survey
Hi Lain, hi Simon,
after attentively reading where documentation requests are to be
placed, I sent a request to the last docspree event. I did not expect
to get an answer but I did expect that the results of my suggestion
would pop up in the nightly docs library sometime later. They did not.
So all in vain?
I'm really confused where to place requests to be processed in a
straightforward manner outside of Jira. Sorry if I'm misunderstanding
the intention of docspree. Btw. I see you've done very good work, keep
on.
Peter
Sun, 2011-11-27, 15:17
#3
Re: Re: Monthly docspree & survey
What and where was the request? The docspree contributors are free to contribute documentation where they wish and best feel able to do so. This may or may not line up with your request.
- Josh
On Sun, Nov 27, 2011 at 5:17 AM, Sonnenschein <peter.empen@arcor.de> wrote:
- Josh
On Sun, Nov 27, 2011 at 5:17 AM, Sonnenschein <peter.empen@arcor.de> wrote:
Hi Lain, hi Simon,
after attentively reading where documentation requests are to be
placed, I sent a request to the last docspree event. I did not expect
to get an answer but I did expect that the results of my suggestion
would pop up in the nightly docs library sometime later. They did not.
So all in vain?
I'm really confused where to place requests to be processed in a
straightforward manner outside of Jira. Sorry if I'm misunderstanding
the intention of docspree. Btw. I see you've done very good work, keep
on.
Peter
Sun, 2011-11-27, 17:27
#4
Re: Re: Monthly docspree & survey
On Sat, Nov 26, 2011 at 4:53 PM, Simon Ochsenreither <simon.ochsenreither@googlemail.com> wrote:
I think the events needs more exposure. This means reports BEFORE and AFTER the event on scala-lang.org.
(This of course would require that it would take less than 4 weeks to promote already written and submitted reports to the front page. *sarcasm*)
Sorry, someone dropped the ball there. I'll try to get people to do something about it.
-- Martin
Sun, 2011-11-27, 17:47
#5
Re: Monthly docspree & survey
Josh, it was not a contribution but the following request for
additional documentation:
"scala.inline: Please refer to the final modifier and describe any
relationship with it because this is a frequent question on the user
list."
I sent it to a docspree participant. So how to proceed such cases? Is
JIRA the only place?
Peter
Mon, 2011-11-28, 03:07
#6
Re: Re: Monthly docspree & survey
I would love to participate in one of these events, except that they
always seem to happen on a day that I'm not available. I'll see if I
can contribute a couple of hours on Mondays - I have a more flexible
schedule that day.
Perhaps that's the solution - encourage individuals and small groups
to work on stuff whenever they can fit it in, rather than, or in
addition to the monthly events.
Donald
Mon, 2011-11-28, 14:37
#7
Re: Re: Monthly docspree & survey
That documentation pretty much needs to be written by someone who understands the inliner in the compiler. Not sure that's the regular old joe of a docspree. It is a valuable enough request you should probably add it to the docspree wiki (in case someone wants to go investigate) or just ask on scala-internals a few simple questions, then write the documentation.
On Nov 27, 2011 11:33 AM, "Sonnenschein" <peter.empen@arcor.de> wrote:Josh, it was not a contribution but the following request for
additional documentation:
"scala.inline: Please refer to the final modifier and describe any
relationship with it because this is a frequent question on the user
list."
I sent it to a docspree participant. So how to proceed such cases? Is
JIRA the only place?
Peter
Mon, 2011-11-28, 17:27
#8
Re: Re: Monthly docspree & survey
Numeric is also needing documentation. It is pretty much one of the most common “patterns” out there yet it lacks any documentation.
I never actually realized that until I spoke to someone who was completely surprised something like Numeric existed, because he was already looking for it for a long time.
I filed an issue here: https://issues.scala-lang.org/browse/SI-5222
Should probably done by someone very familiar to the inner workings of it ...
I never actually realized that until I spoke to someone who was completely surprised something like Numeric existed, because he was already looking for it for a long time.
I filed an issue here: https://issues.scala-lang.org/browse/SI-5222
Should probably done by someone very familiar to the inner workings of it ...
(This of course would require that it would take less than 4 weeks to promote already written and submitted reports to the front page. *sarcasm*)