[JENKINS-59467] Issue Template: Migrate documentation from Wiki to GitHub · jenkinsci/jenkins#25425

2019-09-21T00:37:32.000Z

We have recently introduced support of GitHub documentation on the Jenkins Plugin Site . See https://groups.google.com/forum/#!topic/jenkinsci-dev/VSdfVMDIW-A for the announcement. Jenkins users seeking documentation will have a better user experience on plugins.jenkins.io than they do on wiki.jenkins.io. At the same time, maintainers can follow the documentation-as-code approach and make documentation changes a part of pull requests. Documentation changes will be reviewed as part of pull requests and documentation contributors will be recognized, especially when combined with Release Drafter . We recommend all plugins to migrate documentation to GitHub. Steps: Select a plugin you want to improve from the TODO plugins in the plugin migration progress page , clone this issue and assign the correct component ID. Plugins that have an active maintainer or a larger installation count are more likely to review the pull request and release it. Review the plugin page on the Wiki and in the GitHub README. If there is missing information in the README, submit a pull request with the documentation update Modify the documentation URL in the project file: https://wiki.jenkins.io/display/JENKINS/Hosting+Plugins#HostingPlugins-Referencingthedocumentationpagefromtheprojectfile Once the steps are completed and your pull request is merged by the maintainer, the GitHub landing page will be updated. The next time the plugin releases, the documentation will appear on https://plugins.jenkins.io/ . --- Originally reported by oleg_nenashev , imported from: Issue Template: Migrate documentation from Wiki to GitHub status : Open priority : Minor component(s) : other label(s) : hacktoberfest, newbie-friendly resolution : Unresolved votes : 0 watchers : 3 imported : 2025-12-08 Raw content of original issue <THIS IS A TEMPLATE ISSUE, PLEASE CLONE IT TO WORK ON A PLUGIN> We have recently introduced support of GitHub documentation on the Jenkins Plugin Site . See https://groups.google.com/forum/#!topic/jenkinsci-dev/VSdfVMDIW-A for the announcement. Jenkins users seeking documentation will have a better user experience on plugins.jenkins.io than they do on wiki.jenkins.io. At the same time, maintainers can follow the documentation-as-code approach and make documentation changes a part of pull requests. Documentation changes will be reviewed as part of pull requests and documentation contributors will be recognized, especially when combined with Release Drafter . We recommend all plugins to migrate documentation to GitHub. Steps: Select a plugin you want to improve from the TODO plugins in the plugin migration progress page , clone this issue and assign the correct component ID. Plugins that have an active maintainer or a larger installation count are more likely to review the pull request and release it. Review the plugin page on the Wiki and in the GitHub README. If there is missing information in the README, submit a pull request with the documentation update Modify the documentation URL in the project file: https://wiki.jenkins.io/display/JENKINS/Hosting+Plugins#HostingPlugins-Referencingthedocumentationpagefromtheprojectfile Once the steps are completed and your pull request is merged by the maintainer, the GitHub landing page will be updated. The next time the plugin releases, the documentation will appear on https://plugins.jenkins.io/ .

(10 comments) (0 reactions) (0 assignees)Java (9,474 forks)batch import

component:otherenhancementgood first issueimported-jira-issuepriority:minorresolution:unresolved

Repository metrics

Stars: (25,266 stars)
PR merge metrics: (Avg merge 10d 9h) (93 merged PRs in 30d)

Description

Contributor guide

Research direction: Select a plugin from the migration progress page, review its Wiki and GitHub README, update the README if needed, and modify the documentation URL in the project file.
Tech stack: None
Domain: documentation
Issue type: Documentation
Difficulty: 1
Estimated time: 1-3 hours
Activity status: Active
Clarity: Clear
Prerequisites: Git
Newbie friendliness: 85

Repository metrics

Description

Contributor guide

Get fresh easy issues in your inbox.