GSoD 2020
Organisation Name: SunPy
Description: sunpy is a community-developed free and open-source software package for solar physics. It aims to be a comprehensive data analysis environment that allows researchers within the field of solar physics to carry out their tasks with the minimal effort.
Link: sunpy.org
Google Season of Documentation GSOD 2020
Description: SunPy has extensive documentation for both users and developers. However a lot of this documentation is focused on the technical aspects of how to do something but doesn't explain why or what. It is also not immediately obvious where to get what type of information. The Diátaxis documentation framework and accompanying video from PyCon Australia 2017 do a fantastic job of outlining the different functions and aims of the four major categories of documentation: information and tutorials, how-to guides, technical reference and explanation.
For a great example of this approach see django docs
Sunpy already has documentations that covers 3 of these categories pretty well if not in the exact same format:
| Section | Current Docs |
|---|---|
| Information and Tutorials | User Guide and Example gallery |
| How-Tos | User Guide and Example gallery |
| Explanations | Some information scattered through out documentation |
| Reference | Code Ref |
The idea for this years GSOD would be refactor the documentation to make content more discoverable and in particular to create an easy to discover place for "Explanations". This would involve working with the community to reorganise and edit the existing documentation and facilitating the creation of new content by providing authoring guidelines for each type of documentation. The aim would be for the community and technical writer to collaborate to create new content especially around domain specific topics. The guidelines would allow the maintenance and expansion of the documentation beyond this years GSOD and into the future.
Related material:
- The sunpy docs https://docs.sunpy.org/en/stable/
- The sunpy dev guide https://docs.sunpy.org/en/latest/dev_guide/index.html
- The documentation on readthedocs https://readthedocs.org/projects/sunpy/
- Guide to documentation layout Diátaxis framework
- Sunpy repo https://github.com/sunpy/sunpy
- SunPy chat https://riot.im/app/#/room/#sunpy:openastronomy.org
- SunPy mailing list https://groups.google.com/forum/#/sunpy-dev
