Zulip-GSoD 2019 Project Report
The project focused on three aspects of documentation needs. 1) Upgrades to the documentation system’s build tools and troubleshooting warnings and other tooling issues along the way. 2) Improvements to the overall organization/quality of the and areas of Zulip’s developer documentation. 3) Simplification of articles in so that new users can learn how to access and interact with Zulip’s REST API more easily.
List of commits that Zulip merged into its repository sorted by merged date in descending order:
List of PRs that correspond to merged commits and include more details and discussion:
Reorganized content of articles and subsections
Open Pull Requests pending review
- Better organize the “Subsystems” section of the developer docs.
- Proofread and polish newly merged articles in the “Production” section.
- +Roadmap for "REST API” docs: This document is a checklist of the near-term projects to make the API documentation better.
Challenges and Learnings:
- At first, I didn’t have a clear procedure on how to merge articles/subsections correctly which led to some confusion and undoing/redoing work, but then after some back and forth it was pretty much smooth sailing.
- It was quite helpful when my mentor helped refocus priorities about halfway through the project. The guidance Tim provided realigned the documentation efforts with Zulip’s current goals towards an upcoming major release. I felt this improved the overall experience of the project.
- It was good to learn about reporting issues to upstream projects to help others in the open source community as well as receive help from them if someone figured out a solution.
- It was nice to receive a prompt and positive response from several developers after @mentioning them in a PR asking if we could list their projects in the documentation.