Google Season of Docs in Jenkins

Google Season of Docs

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.

GSoD 2020

Jenkins project will be a mentoring organization in Google Season of Docs 2020. We invite technical writers to join the community and contribute to the documentation being used by millions of Jenkins users worldwide.

Project ideas

We invite technical writers to contribute to a major documentation update effort being coordinated in the documentation SIG. It includes a number of ongoing projects, and technical writers are welcome to make their proposals in any area of the Jenkins documentation. We encourage proposals based on a technical writer’s expertise and interests.

Project idea Keywords Description and links

Plugin documentation migration and update

Markdown, GitHub, Plugins, Rewrite, Copy-editing

Currently we are migrating our plugin documentation from Confluence to GitHub, see this blog post for announcement. We have already moved hundreds of pages, but there are more than 1000 pages remaining. Migration itself can be done with automated tools we provide, but the documentation usually needs a significant update due to new features. We invite technical writers to select an area (e.g. "plugins for Docker"), and work closely with plugin maintainers to migrate and update documentation in such an area. More Info

Document Jenkins on Kubernetes

AsciiDoc, Guide, Compilation, Kubernetes

Jenkins on Kubernetes is a popular theme for Jenkins users. There were a lot of presentations and articles about running Jenkins on Kubernetes, but we need a central location for documentation describing Jenkins on Kubernetes. We would like to create new documentation which would describe the concepts, techniques, and choices for Kubernetes users running Jenkins. More Info

Jenkins user documentation reorganization and update

AsciiDoc, Guide, Rewrite

Jenkins user topics are included in the current Jenkins Handbook, and are frequently received to improve the user documentation. Common improvement themes include adding pipeline examples with each of the pipeline steps and additional tutorials for new users. The main aim of this project would be to restructure content to make it more discoverable and easy to read. More info

Create new solution pages for Jenkins use-cases

AsciiDoc, Guide

Jenkins project has several solution pages for various use-cases. We invite technical writers to create new solution pages for various use-cases (e.g. Documentation as code, Continuous Deployment, Static Analysis) or technologies (Git, Gitlab, Kubernetes, etc.). Existing pages were created several years ago, and they could be also updated. There are a lot of materials available on the web, but having dedicated solution pages could help users to discover such materials. More info

Getting started

If you are interested to participate in Google Season of Docs as a technical writer, please do the following:

  1. Join our Mailing list and Gitter Channel.

  2. Explore the project ideas listed on this page, find areas which would be interesting to you.

  3. Try contributing to Jenkins documentation to study our documentation tools and contribution process. There are some newcomer-friendly documentation tasks you could try.

  4. If you start exploring the project before May 29, consider joining our UI/UX hackfest which includes the user documentation track. It is a good opportunity to get know the community better.

  5. Send an introductory email to our mailing list. Please include a short self-introduction and list projects which would be interesting to you.

Team

Technology and tools

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.

Contacts

We will be using the Documentation SIG communication channels for GSoD project discussions during the application phases.

Once the projects are announced, other project-specific channels might be created by teams during the community bonding.

Additional Information

Office Hours

Documentation office hours are held each Monday at 22: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.

Previous years