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 )Members
Description
The SIG offers a venue for all kinds of documentation creation, improvement, and delivery.
The group focuses on documentation for Jenkins and Jenkins X, including:
-
User documentation - Using Jenkins
-
References like Pipeline Syntax and Pipeline Steps
-
How-to Guides
-
Extension documentation - Extending Jenkins
-
Solution documentation - Specific Solutions with Jenkins
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
Ongoing projects
-
Reviewing Jenkins documentation bug reports
-
Identifying newbie-friendly documentation bug reports
-
Reviewing Jenkins documentation pull requests
-
Reviewing Jenkins X documentation pull requests
-
Plugins site improvements
See the SIG meeting notes for more information about ongoing projects.
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.
