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.

Ongoing 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 50 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:

Documentation Reviews

Meetings

We have regular meetings on Fridays every two weeks, at 1PM UTC. See the Jenkins Event Calendar for the schedule. At these meetings we discuss projects and do presentations/demos. You can find and contribute to the agenda for the incoming meetings here.

Meetings are conducted and recorded using Zoom. Participant links are posted in the SIG Gitter Chat 10 minutes before the meeting starts.

(Back to List of Jenkins Special Interest Groups)