[JENKINS-59467] Issue Template: Migrate documentation from Wiki to GitHub

[jenkins-infra-bot]

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/.

 

[jenkins-infra-bot]

• Remote link associated with this issue:

  • Announcement in the developer mailing list

[jenkins-infra-bot]

mayank77maruti:

• Original comment link
• Raw content of original comment:

  Hey oleg_nenashev , is this issue open to be worked on.
  
  Thank you.
  

Hey oleg_nenashev , is this issue open to be worked on.

Thank you.

[jenkins-infra-bot]

markewaite:

• Original comment link
• Raw content of original comment:

  mayank77maruti as noted in the issue description:
  
  <THIS IS A TEMPLATE ISSUE, PLEASE CLONE IT TO WORK ON A PLUGIN>
  
  This is not an issue that will be worked.  It is an issue that contributors clone when they need to work on a plugin that they choose.  There are still some plugins that need their documentation transitioned from the Jenkins Wiki to GitHub.  For example, you could create a copy of this issue and assign it to the JDK_Parameter plugin.  Then you would follow the instructions to migrate the documentation from the Wiki to GitHub.
  

mayank77maruti as noted in the issue description:

This is not an issue that will be worked. It is an issue that contributors clone when they need to work on a plugin that they choose. There are still some plugins that need their documentation transitioned from the Jenkins Wiki to GitHub. For example, you could create a copy of this issue and assign it to the JDK_Parameter plugin. Then you would follow the instructions to migrate the documentation from the Wiki to GitHub.

[jenkins-infra-bot]

[Original epic from Jira: INFRA-2328]

[adityasah104]

Is this issue still active?

[iamtanmaybaranwal]

Hi! I’d like to work on this issue. Could you please assign it to me? Thanks!

[Vaibhav34-2006]

Hi, I’m Vaibhav and I’m preparing for GSoC 2026.
I’d like to work on this issue if it’s still available.
Could you please confirm and guide me on the next steps?

[0xShubhamSolanki]

Hi, I understand that this is a template issue.
I will clone it and select a plugin from the migration list to work on documentation transition.
Please let me know if there are any recommended plugins for new contributors.

[0xShubhamSolanki]

Documentation migration submitted for JDK Parameter Plugin:

jenkinsci/JDK_Parameter_Plugin-plugin#57