On Mon, May 27, 2019 at 3:22 PM swati thacker <[email protected]> wrote: > > Hi there! > > I am a technical writer with 9 years of experience and am currently pursuing > my interest in Python. I have completed a couple of courses in Python and I > have worked with a variety of XML and HTML based documentation tools. I also > have a good working knowledge of the git version control system. After > surfing through your GSoD project ideas page, I found myself interested in > working on cleaning up the developer documentation and new contributor > documentation. I have a few questions: > > Is this the developer documentation that you wish to cleanup - > https://github.com/sympy/sympy/wiki? This wiki contains close to 500 pages!
Yes. To be sure, a large fraction of pages on the wiki are old GSoC student applications. These pages should be left alone, although the organization around them could be improved. There are also some "sandbox" type pages (since it is a wiki), which don't necessarily contain useful information anymore. A part of the project would be to determine for each page what to do with it, which could be anything from completely revamping to just leaving it alone to deleting it. > Are these projects time-bound and short-term or are they long-term? My understanding is that the program has both short and long running projects. See https://developers.google.com/season-of-docs/docs/timeline. The short running projects run from September 2 to November 29. Long running projects run to February 28, 2020. See also https://developers.google.com/season-of-docs/docs/glossary#long-running-project. I think for the SymPy projects, you should determine first if you want to do a short running or long running project, and then determine how much should be done when creating your application. I think most of our ideas can have a good amount of work done for the shorter term, but could also be stretched into longer term goals as well. > > I also wish to share some ideas about organizing the documentation on your > website. Please let me know how and where to get started. I guess you can discuss them here, on this mailing list. And also put them in your application if you want to work on that project. A big part of GSoD is for tech writers to help open source projects better understand how to organize/write their documentation, as that is their area of expertise and not ours. So if you have ideas on how we can improve our documentation, we definitely want to hear them. Aaron Meurer > > Thank you for your time, > ~Swati > > > -- > 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 [email protected]. > To post to this group, send email to [email protected]. > 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/1fdcf813-7fef-4fc1-ab9b-52a8a18c31ad%40googlegroups.com. > For more options, visit https://groups.google.com/d/optout. -- 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 [email protected]. To post to this group, send email to [email protected]. 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/CAKgW%3D6KwnsL%2Bp3%3D%2Bj7MqYX8qMPhB-7V73pHdU_ZBhsVXCfS0rw%40mail.gmail.com. For more options, visit https://groups.google.com/d/optout.
