Documentation

Overview

This special interest group improves Jenkins use and adoption through documentation. The SIG encourages, creates, and reviews documentation contributions and improves documentation with contributors and external communities.

(Back to List of Jenkins Special Interest Groups )

Description

The SIG offers a venue for all kinds of documentation creation, improvement, and delivery.

The group focuses on documentation for Jenkins, including:

Documentation SIG may cooperate with other groups. For example, we will be cooperating with the Cloud-Native Jenkins SIG on topics related to Cloud-Native documentation efforts and with the Platform SIG. on platform topics.

Topics

  • Creating new documentation

  • Improving existing documentation

  • Reviewing documentation contributions

  • Coordinating documentation initiatives

  • Reviewing Jenkins Enhancement Proposals (JEPs) related to documentation

Contributing

See this page for information about contributing to Jenkins documentation. It contains links for newcomer and seasoned contributors. If you have any questions or ideas, please feel free to reach out to us using the channels listed on the right panel.

Projects

This sections lists some of the projects being done under umbrella of this SIG. See the SIG meeting notes for more information about ongoing projects.

Plugin site integration with GitHub

Jenkins Plugin Site currently uses Jenkins update center and Jenkins Wiki as a main source of information to be displayed on the website. We have recently added support of plugin documentation from GitHub (announcement), but there are still many improvement areas: visualizing changelogs, pulling plugin tags and maintainers list from GitHub, etc. This project is tracked in the WEBSITE-637 EPIC.

Useful links:

Plugin documentation on GitHub

Currently the SIG is migrating plugin documentation from https://wiki.jenkins.io/ to GitHub. Documentation in the plugin GitHub repository provides a good user experience for Jenkins users seeking documentation. At the same time, plugin maintainers now can follow the documentation-as-code approach and make documentation changes a part of the pull requests. It also gives an opportunity to review the documentation changes and to add documentation contributor recognition, especially if the story is combined with changelog automation.

We have more than 300 plugins which already use GitHub as a documentation source, but there are still hundreds of plugins to migrate. We invite contributors to participate in the project and to help us with migrating the docs. It is also a great opportunity to update and copy-edit the documentation.

Useful links:

User Guide Rework

Jenkins user topics are included in the current Jenkins Handbook. Feedback requests are frequently received to improve user documentation. Common improvement themes include adding migration of the documentation from Wiki, pipeline examples with each of the pipeline steps, additional tutorials for new users, better search and navigation.

Links:

Administrator Guide

Jenkins administration topics are included in the current Jenkins Handbook. Navigation can be improved for administrators by separating the administration topics into a separate volume. This project will create a separate Jenkins Administrator Guide with content specific for administrators. This project is tracked in the WEBSITE-738 EPIC.

Jenkins on Kubernetes

Jenkins on Kubernetes is a popular theme of Jenkins Meetups and presentations at conferences. The Jenkins on Kubernetes project will describe the concepts, techniques, and choices for Kubernetes users running Jenkins. The project can refer to existing information from:

Solution Pages

Jenkins solution pages highlight specific use cases for Jenkins users. Those solutions include SCM provider solutions (GitHub, Bitbucket), programming language solutions (Python, Ruby, C/C++, Java, and PHP), and execution environment solutions (Pipeline, Docker, Embedded, and Android). An excellent opening page has been provided by Zbynek Konecny. Additional use cases and user stories are being collected by Alyssa Tong.

The appearance and navigation of those solution pages needs improvement. The existing pages should be revisited and improved so that users of specific solutions can find what they need on jenkins.io. This project is tracked in the WEBSITE-742 EPIC.

Documentation Reviews

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.

See this page for more info.

Meetings

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.

The Documentation SIG meets on the fourth Friday of each month at 13:00 UTC. See the Jenkins Event Calendar for the schedule. At these meetings we discuss projects, share presentations, and demonstrate new capabilities. 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.

Meeting Agendas

Meeting agendas and meeting notes for the SIG are posted in this Google Document. Anyone is welcome to add a topic for an upcoming meeting by suggesting a change in the agenda.

(Back to List of Jenkins Special Interest Groups)