Skip to content

Migrate documentation from Wiki to GitHub#57

Merged
MarkEWaite merged 2 commits intojenkinsci:masterfrom
0xShubhamSolanki:docs/migrate-wiki-documentation
Feb 21, 2026
Merged

Migrate documentation from Wiki to GitHub#57
MarkEWaite merged 2 commits intojenkinsci:masterfrom
0xShubhamSolanki:docs/migrate-wiki-documentation

Conversation

@0xShubhamSolanki
Copy link
Copy Markdown
Contributor

Description

This PR migrates the plugin documentation from the Jenkins Wiki export to the GitHub README.

The existing README was very minimal and had not been updated in many years.
I have restructured the documentation in Markdown format and moved the relevant content from the Wiki export, including:

  • Description
  • Installation steps
  • Configuration details
  • Usage section
  • Known issues
  • Changelog

I also added a simple Pipeline usage example to make the documentation clearer for users.

This follows the documentation migration effort described in JENKINS-59467.


Testing done

This change only updates documentation.

I verified that the Markdown renders correctly in the GitHub preview.
No source code or runtime behavior was modified.

Copy link
Copy Markdown
Contributor

@MarkEWaite MarkEWaite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks very much!

I've requested several changes.

Please also update pom.xml and replace https://wiki.jenkins-ci.org/display/JENKINS/JDK+Parameter+Plugin with the value described in the tutorial and the more detailed steps.

Copy link
Copy Markdown
Contributor

@MarkEWaite MarkEWaite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@MarkEWaite MarkEWaite changed the title docs: migrate documentation from Jenkins Wiki to GitHub README Migrate documentation from Wiki to GitHub Feb 21, 2026
@MarkEWaite MarkEWaite merged commit 55332ad into jenkinsci:master Feb 21, 2026
16 checks passed
@0xShubhamSolanki
Copy link
Copy Markdown
Contributor Author

Thank you for the review and guidance on this PR. I really appreciate the feedback and the opportunity to contribute.
I’m planning to stay actively involved with Jenkins this year and would be glad to help further. If there are specific areas where help is needed, I’d appreciate any suggestions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants