Google Season of Docs
145 views
Skip to first unread message
Aaron Meurer
Mar 13, 2019, 3:05:31 PM3/13/19
to sy...@googlegroups.com
Google is starting a new program, Google Season of Docs (GSoD). I'd
like to gauge the community's interest in applying.
Full information about the program is here:
https://developers.google.com/season-of-docs/
The program is very similar to Google Summer of Code, but unlike GSoC,
it focuses on documentation instead of code. Also unlike GSoC, the
program is aimed toward people with technical writing experience
rather than students. The idea is to give open source projects a
chance to have a professional technical writer help them with their
documentation. The technical writers learn more about open source
technologies and get something they can add to their resume.
Should SymPy apply? The application period intersects with GSoC a bit,
but the actual mentoring period does not
(https://developers.google.com/season-of-docs/docs/timeline).
Aaron Meurer
like to gauge the community's interest in applying.
Full information about the program is here:
https://developers.google.com/season-of-docs/
The program is very similar to Google Summer of Code, but unlike GSoC,
it focuses on documentation instead of code. Also unlike GSoC, the
program is aimed toward people with technical writing experience
rather than students. The idea is to give open source projects a
chance to have a professional technical writer help them with their
documentation. The technical writers learn more about open source
technologies and get something they can add to their resume.
Should SymPy apply? The application period intersects with GSoC a bit,
but the actual mentoring period does not
(https://developers.google.com/season-of-docs/docs/timeline).
Aaron Meurer
Arif Ahmed
Mar 13, 2019, 4:59:54 PM3/13/19
to sympy
The SymPy docs are quite fine but I feel most of the modules could use a lot more comments(in-line and block, existing docstrings are already quite good !)
It would make it easier for contributors(especially new ones) to fix bugs if there were comments explaining the underlying algorithm/math.
Here is a good example of what I mean(lines 846 to 1066 have a fairly decent explanation of the process used). Unfortunately such comments seem rare to me throughout the library.
Jason Moore
Mar 15, 2019, 11:18:43 AM3/15/19
to sy...@googlegroups.com
> Should SymPy apply?
Yes!
I'm willing to help with that (likely).
Jason
--
You received this message because you are subscribed to the Google Groups "sympy" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sympy+un...@googlegroups.com.
To post to this group, send email to sy...@googlegroups.com.
Visit this group at https://groups.google.com/group/sympy.
To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/76b1e451-00ac-490c-a26b-1cc0d9ccec00%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
Aaron Meurer
Mar 15, 2019, 12:55:53 PM3/15/19
to sy...@googlegroups.com
Thanks Jason. Just to clarify, are you able to help with both the
application (due April 23) and the mentoring?
I also think we should apply. I read some more on their site.
Apparently as part of their pilot, they are only going to have 50
slots, with a max of 2 slots per project
(https://developers.google.com/season-of-docs/docs/faq#slot-allocation).
I guess this means they will be accepting about 25 orgs, so depending
on how popular this is, we may need to work extra hard to get
accepted.
Here are the instructions for the application
https://developers.google.com/season-of-docs/docs/organization-application-hints.
If you want to start thinking of project ideas, that would be helpful.
Feel free to start a page on the wiki for this. We won't know what the
actual application form looks like until it opens on April 2.
Aaron Meurer
> To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/CAP7f1AiGuyJm4FcY4opBms9iC3xZ%3DjRXeFXDK%2Bgz9w2%2BCad3Zw%40mail.gmail.com.
application (due April 23) and the mentoring?
I also think we should apply. I read some more on their site.
Apparently as part of their pilot, they are only going to have 50
slots, with a max of 2 slots per project
(https://developers.google.com/season-of-docs/docs/faq#slot-allocation).
I guess this means they will be accepting about 25 orgs, so depending
on how popular this is, we may need to work extra hard to get
accepted.
Here are the instructions for the application
https://developers.google.com/season-of-docs/docs/organization-application-hints.
If you want to start thinking of project ideas, that would be helpful.
Feel free to start a page on the wiki for this. We won't know what the
actual application form looks like until it opens on April 2.
Aaron Meurer
Jason Moore
Mar 15, 2019, 4:49:28 PM3/15/19
to sy...@googlegroups.com
To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/CAKgW%3D6J%2B8AApA8ytfo_e5sFQXwFoc%2BGnRNrpu2Z_6LCqPiUT-Q%40mail.gmail.com.
Aaron Meurer
Mar 15, 2019, 4:56:25 PM3/15/19
to sy...@googlegroups.com
Great. Let me know if you want to set up a meeting where we can work
on it together. Probably some time after the 2nd so that we know what
the application looks like.
If anyone else is interested in helping out as well, let me know.
Aaron Meurer
> To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/CAP7f1AgZA-CfG2yS4gcfWdtnHe8W--rt%3DAmdXOf%3DSgQQmt%2Bgag%40mail.gmail.com.
on it together. Probably some time after the 2nd so that we know what
the application looks like.
If anyone else is interested in helping out as well, let me know.
Aaron Meurer
Aaron S. Meurer
Apr 6, 2019, 4:34:40 PM4/6/19
to sy...@googlegroups.com, Jason Moore
The org applications for Google Season of Docs are now open. https://developers.google.com/season-of-docs/docs/get-started/. The deadline is April 23 which is in about two weeks.
Jason, we should schedule a time to work on it. If anyone else is interested in helping let me know.
Aaron Meurer
To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/CAP7f1AgZA-CfG2yS4gcfWdtnHe8W--rt%3DAmdXOf%3DSgQQmt%2Bgag%40mail.gmail.com.
Nikhil Maan
Apr 7, 2019, 3:34:04 AM4/7/19
to sympy
Dear Aaron,
I would like to help SymPy with GSoD.
I love it when someone wants to improve their documentation and readability.
I might not be very familiar with SymPy documentation right now.
But, the program wil effectively begin in September.
By that time, (specially with GSoC), I would get familiar with the SymPy's documentation.
I am willing to help with that whenever required. Give me some time to read about the program.
Regards,
Nikhil Maan
Mayank Jha
Apr 7, 2019, 4:00:32 AM4/7/19
to sy...@googlegroups.com
Hi Aaron,
My name is Mayank Jha and I am a pre-final year B.Tech CSE Student at GGSIPU Delhi. I am also interested in helping SymPy with GSoD.
Please help me to get started.
Hoping to hear from you soon.
Regards
Mayank Jha
Aaron Meurer
Apr 23, 2019, 3:42:57 PM4/23/19
to sympy
It's a little close to the deadline (about 20 minutes), but I am
trying to get an application in for GSoD.
If anyone is interested in mentoring, please fill out this form
https://forms.gle/a1x26WQGzURLerv66. You may need to do it within the
next 20 minutes.
Aaron Meurer
trying to get an application in for GSoD.
If anyone is interested in mentoring, please fill out this form
https://forms.gle/a1x26WQGzURLerv66. You may need to do it within the
next 20 minutes.
Aaron Meurer
Reply all
Reply to author
Forward
0 new messages