Plugin docs migration to GitHub as a Hacktoberfest project

45 views
Skip to first unread message

Mark Waite

unread,
Sep 28, 2021, 10:42:51 PM9/28/21
to Jenkins Developers
We still have over 1000 plugins that have not converted their documentation to be hosted in the plugin repository on GitHub.  If your plugin pom.xml includes <url>https://wiki.jenkins.io/...</url>, then your plugin needs to be converted to host its documentation in the plugin repository.

The conversion process is a good project for Hacktoberfest contributors.  We'd like Hacktoberfest contributors to submit documentation conversion pull requests to plugins where the maintainers are willing to review the documentation pull request, merge it, and release a new version of the plugin so that the updated documentation is used on the https://plugins.jenkins.io site.

If you are the maintainer of a plugin and have not switched your plugin documentation to GitHub already, would you be willing to review Hacktoberfest pull requests that would move the documentation for your plugins from the obsolete Jenkins wiki into the GitHub plugin repository?

Are you willing to release a new version of the plugin after the documentation pull request has been merged?

We're assembling the prioritized list of plugins for the conversion and would rather not have a Hacktoberfest contributor submit a documentation pull request if the plugin maintainers are unwilling to review the pull request.

Reply to this thread with the plugin name or plugin artifact ID if you're a maintainer of the plugin and are willing to review a docs pull request to your plugin during Hacktoberfest.  Those who have already replied to me directly do not need to also reply to this thread.

Mark Waite

Jesse Glick

unread,
Sep 29, 2021, 8:12:33 AM9/29/21
to Jenkins Dev
Does the automated conversion tool even still work now that Confluence is dead? Or do you need to write docs from scratch / memory?

Tim Jacomb

unread,
Sep 29, 2021, 8:19:24 AM9/29/21
to jenkin...@googlegroups.com

On Wed, 29 Sep 2021 at 13:12, Jesse Glick <jgl...@cloudbees.com> wrote:
Does the automated conversion tool even still work now that Confluence is dead? Or do you need to write docs from scratch / memory?

--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to jenkinsci-de...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/CANfRfr0UQHdQvSToA0rgwOZTwHz3kAFoH%3DTfnQNdS_WEsayRSw%40mail.gmail.com.

Mark Waite

unread,
Sep 29, 2021, 11:48:44 AM9/29/21
to jenkinsci-dev
I'll be updating the instructions on www.jenkins.io to use the https://github.com/jenkins-infra/plugins-wiki-docs repository.  We did a live conversion of the Ansible plugin docs as part of Docs Office Hours a few weeks ago using https://github.com/jenkins-infra/plugins-wiki-docs.  Worked great.

I will likely also include a pointer to the wayback machine in case someone needs to see how the wiki page looked previously.

Reply all
Reply to author
Forward
0 new messages