Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Read GitHub pipeline docs from GitHub for plugins.jenkins.io #75

Merged

Conversation

MarkEWaite
Copy link

@MarkEWaite MarkEWaite commented Apr 10, 2020

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

@MarkEWaite MarkEWaite changed the title Use github for plugins.jenkins.io docs Use github for GitHub pipeline docs on plugins.jenkins.io docs Apr 10, 2020
@MarkEWaite MarkEWaite changed the title Use github for GitHub pipeline docs on plugins.jenkins.io docs Use github for GitHub pipeline docs on plugins.jenkins.io Apr 10, 2020
@MarkEWaite MarkEWaite changed the title Use github for GitHub pipeline docs on plugins.jenkins.io GitHub pipeline docs read from GitHub for plugins.jenkins.io Apr 10, 2020
@MarkEWaite MarkEWaite changed the title GitHub pipeline docs read from GitHub for plugins.jenkins.io Read GitHub pipeline docs from GitHub for plugins.jenkins.io Apr 10, 2020
@aaronjwhiteside
Copy link

Thanks @MarkEWaite! I never knew you could do this!

@aaronjwhiteside aaronjwhiteside merged commit 1c8487e into jenkinsci:master May 9, 2020
@MarkEWaite MarkEWaite deleted the use-github-for-plugin-docs branch May 9, 2020 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants