The Google Season of Docs (GSoD) program brings together open source and technical writers communities for the benefit of both. The program raises awareness of open source, of docs, and of technical writing. GSoD in Jenkins is organized by the Documentation special interest group.
The Docs SIG plans to apply as a mentoring organization in Google Season of Docs 2021. See our organization proposal and application draft.
Significant documentation project opportunities are listed in the Google Season of Docs project ideas.
If you are interested to participate in Google Season of Docs as a technical writer, please do the following:
Explore the project ideas listed on this page, find areas which would be interesting to you.
Send an introductory email to our mailing list. Please include a short self-introduction and list projects which would be interesting to you.
For all new documentation projects we are using the Documentation as Code approach when documentation is developed using markup languages and stored in source control management (SCM) systems. Here are the common tools we use:
Particular components may also require additional tools for documentation development. For example, the jenkins.io website requires Docker for being built and tested locally. In such cases we document usage of these tools in our contributing guidelines and help newcomer maintainers if needed.
Documentation office hours are held each Monday at 23:00 UTC and each Thursday at 16:00 UTC. Meetings are conducted and recorded using Zoom and archived to the Jenkins YouTube channel in the Jenkins Docs SIG YouTube playlist. Participant links are posted in the SIG Gitter Chat 10 minutes before the meeting starts. Participant links are also available in the Jenkins event calendar.
The Jenkins project was a mentoring organization in Google Season of Docs 2020. The writing project started September 14, 2020 and concluded November 30, 2020. See the project report by Zainab Abubakar for details of the writing project and our first experience as a Google Season of Docs mentoring organization.