Document

Jenkins has lots of documentation, and we appreciate any contributions to it: new docs, design and styling, copy-editing, reviews, etc.

We coordinate and discuss documentation efforts in the Documentation Special Interest Group. You can reach out to us in the mailing list or on Gitter, and you can also join our regular meetings. See the contacts on the right sidebar.

Where to find documentation?

There are many documentation sources in Jenkins. This website and the plugins site are the most notable ones, but we also have docs in other places (GitHub repositories, various sites like javadoc.jenkins.io or Jenkins Wiki which is currently being deprecated). For the most of the repositories we try to follow the documentation-as-code approach.

Documentation type Repository Comments and links

User documentation

jenkins-infra/jenkins.io

Contributing guidelines.

Developer documentation

jenkins-infra/jenkins.io

Contributing guidelines.

Solution pages

jenkins-infra/jenkins.io

Contributing guidelines

Plugin documentation

Plugin repositories or Jenkins Wiki

See Developer documentation for more information about plugin docs and the ongoing migration from Wiki to GitHub.

Newcomers

If you are a newcomer, documentation is a great place to contribute. A lot of small patches can be done from the GitHub’s web interface even without forking repositories and cloning them locally. You can open any GitHub Markdown or Asciidoc page in any Jenkins repo, click Edit on the page, modify and preview changes in the web interface, and then propose a change.

Useful links:

Currently we are working on migrating the documentation from Jenkins Wiki to GitHub and jenkins.io. See this blog post for more information about the reasons why we do this migration. This migration involves modification of hundreds of pages and repositories, and we invite everyone to contribute.

There are also other ongoing projects which you can find on the Documentation SIG page and in the project roadmap.

On this page

Connect