Document
|
This site is the new docs site currently being tested. For the actual docs in use please go to https://www.jenkins.io/doc. |
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 the deprecated Jenkins Wiki). For the most of the repositories we try to follow the documentation-as-code approach.
| Documentation type | Repository | Comments and links |
|---|---|---|
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:
-
More advanced documentation tasks (no
good first issuelabel set) -
Documentation SIG Page with links to the Jenkins documentation
-
Writing and Formatting on GitHub (applies to Github Markdown documentation)
Featured projects
Good first issues
The documentation issue list includes issues that are good for first time contributors. See the "good first issues" list.
If you decide to work on an issue, add a comment to the issue that tells others you are working on it. For example, add the comment "I’m working on this issue". You do not need to wait for someone to assign you an issue. Choose an issue, add a comment, and start writing.
Migrating Plugin Documentation to GitHub
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.
Migrating Other Documentation to www.jenkins.io
Jenkins user documentation was initially created in the Jenkins Wiki. The Jenkins wiki was made read-only in 2019. Jenkins documentation improvements are now made on the Jenkins documentation site at www.jenkins.io.
Some of the documentation on the deprecated Jenkins Wiki is still useful. Skilled Jenkins users and administrators may find Wiki information that is still accurate and can be added to www.jenkins.io. They are encouraged to submit pull requests for those cases.
This is not a task for new contributors or for those who are not experienced with Jenkins. New contributors and inexperienced Jenkins users should assist with other documentation tasks rather than attempting to migrate documentation from the wiki to www.jenkins.io.
There are also other ongoing projects which you can find on the Documentation SIG page and in the project roadmap.