Read GitHub pipeline docs from GitHub for plugins.jenkins.io #75
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Use GitHub for plugins.jenkins.io docs
See documenting plugins for more detailed instructions on how the conversion uses either README.md or README.adoc to provide detailed plugin documentation to plugins.jenkins.io. The README is excellent in this repository and provides great documentation for the plugin. Let's show it on plugins.jenkins.io. Note that plugins.jenkins.io reads the pom.xml published with the released plugin. In order to update plugins.jenkins.io, this change needs to be merged and a new version of the plugin needs to be released.
See also documenting plugins blog post.
See also git plugin documentation as an example (can automatically maintain the table of contents in documentation if you choose to switch the docs from markdown to asciidoc, but markdown works great just as this plugin is already documented).