I would first like to remind everyone that we participated in Google Season of Docs last year. This is the report of the project https://github.com/sympy/sympy/wiki/GSoD-2019-Report-Lauren-Glattly:-SymPy-Documentation-Style-Guide. The technical writer, Lauren Glattly, did not write code. However, several proposals came up as part of the project that involved code. We as mentors we able to assist in this. You can see from this milestone https://github.com/sympy/sympy/milestone/54 some of the code related ideas that were implemented, and some which aren't implemented yet. I've asked on the GSoD slack if they have any official policies about code related ideas. I didn't find anything in their guides, although all of their example ideas do not involve any coding https://developers.google.com/season-of-docs/docs/project-ideas.
My personal view is this: we have an entire community who knows how to code, and how to do the above ideas. We even have programs like Google Summer of Code and NumFOCUS small development grants to pay for these things. On the other hand, we don't have any kind of technical writing expertise in our community. The aim of Google Season of Docs is to give open source projects some of that expertise. So even if code projects were allowed, I feel that they would be squandering the opportunity. There are lots of improvements that our documentation needs that doesn't involve any code. There are even ideas that don't require deep knowledge of SymPy or Python. But what they do require is someone who understands how to write documentation in a clear and consistent way that makes it easiest for users to understand. Aaron Meurer On Wed, Apr 15, 2020 at 7:40 PM Nikhil Maan <nikhilmaa...@gmail.com> wrote: > > I am also interested in mentoring for GSoD. I am pretty familiar with the > documentation, and I also have some prior experience as a technical writer, > which might be useful during the program. > As for the question of scope, the program is meant for technical writers, who > might not be too familiar with the language and the tools we are using, apart > from what's required for the documentation. So, any ideas that require > altering code should be kept out of scope IMO. > > 2. Examples are an essential part of any documentation, especially end-user > documentation. So, writing code examples should be kept in scope. If the > writers face some difficulties while writing examples, the mentors should be > able to help them. > > 3. From what I found, meijerint_doc is built using a python script, and it > would require making changes to the code to modify the docs. I think this > should be out of scope. > > I am not sure about 1 and 4. The GSoD guides list some frameworks, including > sphinx, to build the > documentation(https://developers.google.com/season-of-docs/docs/project-ideas). > But, I am not sure to what extent we should expect the writers to be > familiar with the frameworks, and HTML and JS for that matter. I think it > depends on the organization and our requirements. > > Regards, > Nikhil Maan > > On Wednesday, April 15, 2020 at 6:59:42 PM UTC+5:30, S.Y. Lee wrote: >> >> I'm interested in joining the GSoD as a mentor, for some prior experiences >> in solving the sphinx issues in the community. >> But I'd have some other questions to clarify what kind of ideas from below >> are clearly out of scope regarding the comment. >> >>> Ideas that involve writing code are generally out of scope for GSoD. >> >> Modifying the sphinx extension. >> Writing example codes for the doc. >> Automatically generated docs like meijerint_doc. >> Other projects related to the doc website, but which requires some knowledge >> in HTML or javascript. >> >> >> On Tuesday, April 14, 2020 at 5:36:55 AM UTC+9, Aaron Meurer wrote: >>> >>> The Google Season of Docs (GSoD) organization applications are now >>> open. See https://developers.google.com/season-of-docs/docs/admin-guide. >>> >>> If anyone is interested in being a mentor for Google Season of Docs, >>> please let me know about it and fill out the mentor form there. If you >>> are interested in being a co-admin let me know about that too. >>> >>> The deadline to submit our application is May 4. >>> >>> I will start a wiki page for the application soon. For now, if you >>> have any ideas for Google Season of Docs, please edit the ideas page >>> https://github.com/sympy/sympy/wiki/GSoD-2020-Ideas. Note that Google >>> Season of Docs is targeted toward technical writers, so the ideas >>> should be related to writing or editing documentation and other >>> technical resources. Ideas that involve writing code are generally out >>> of scope for GSoD. >>> >>> If you are a technical writer who is interested in working with us, >>> the technical writer application period hasn't started yet, but you >>> can feel free to discuss the ideas on our ideas list with us here on >>> this mailing list. >>> >>> Aaron Meurer > > -- > 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+unsubscr...@googlegroups.com. > To view this discussion on the web visit > https://groups.google.com/d/msgid/sympy/3487f07b-c9a7-47dc-af6a-aeef8e00764d%40googlegroups.com. -- 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+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/CAKgW%3D6%2B-6Sm0tZ1XnF9mVAxARnnAk_S7iObdd1E5zZYNcdOG6A%40mail.gmail.com.
