[JIRA] (JENKINS-60837) Migrate documentation from Wiki to GitHub

Issue Type:	Improvement
Assignee:	Unassigned
Components:	other
Created:	2020-01-22 11:57
Labels:	hacktoberfest newbie-friendly
Priority:	Minor
Reporter:	Victor Martinez

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, clone this issue and assign the correct component ID
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/.

This message was sent by Atlassian Jira (v7.13.6#713006-sha1:cc4451f)

VictorMartinezRubio@gmail.com (JIRA)

unread,

Jan 22, 2020, 6:59:02 AM1/22/20

to jenkinsc...@googlegroups.com

Victor Martinez updated an issue

Jenkins /

Change By:	Victor Martinez
Component/s:	google-compute-engine-plugin
Component/s:	other

VictorMartinezRubio@gmail.com (JIRA)

unread,

Jan 22, 2020, 7:00:02 AM1/22/20

to jenkinsc...@googlegroups.com

Victor Martinez commented on

Re: Migrate documentation from Wiki to GitHub

PR https://github.com/jenkinsci/google-compute-engine-plugin/pull/178

VictorMartinezRubio@gmail.com (JIRA)

unread,

Jan 22, 2020, 7:00:02 AM1/22/20

to jenkinsc...@googlegroups.com

Victor Martinez assigned an issue to Victor Martinez

Jenkins /

Change By:	Victor Martinez
Assignee:	Victor Martinez

VictorMartinezRubio@gmail.com (JIRA)

unread,

Jan 22, 2020, 7:00:03 AM1/22/20

to jenkinsc...@googlegroups.com

Victor Martinez started work on

Change By:	Victor Martinez
Status:	Open In Progress

mark.earl.waite@gmail.com (JIRA)

unread,

Jan 28, 2020, 3:17:02 AM1/28/20

to jenkinsc...@googlegroups.com

Mark Waite updated an issue

Jenkins /

Change By:	Mark Waite

We have recently introduced support of GitHub documentation on the [Jenkins Plugin Site|https://plugins.jenkins.io/]. 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|https://github.com/jenkinsci/.github/blob/master/.github/release-drafter.adoc]. We recommend all plugins to migrate documentation to GitHub.

Steps:
* Select a plugin you want to improve, clone this issue and assign the correct component ID
* 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/.

mark.earl.waite@gmail.com (JIRA)

unread,

Jan 28, 2020, 3:17:03 AM1/28/20

to jenkinsc...@googlegroups.com

Mark Waite updated

Jenkins /

Change By:	Mark Waite
Status:	In Progress Fixed but Unreleased
Resolution:	Fixed