[JIRA] (JENKINS-59467) Issue Template: Migrate documentation from Wiki to GitHub

[o.v.nenashev@gmail.com (JIRA)]

Oleg Nenashev created an issue

Jenkins / JENKINS-59467 Issue Template: Migrate documentation from Wiki to GitHub Issue Type: Improvement Assignee: Unassigned Components: other Created: 2019-09-21 00:37 Labels: newbie-friendly hacktoberfest Priority: Minor Reporter: Oleg Nenashev <THIS IS A TEMPLATE ISSUE, PLEASE CLONE IT TO WORK ON A PLUGIN> 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.  By supporting such source in plugin site we provide good user experience to Jenkins users who look for documentation. At the same time, maintainers can follow the documentation-as-code approach and make documentation changes a part of pull requests. It gives an opportunity to review the documentation changes and to add documentation contributor recognition, especially if the story is combined with Release Drafter. So, we recommend all plugins to migrate documentation to GitHub. Steps: Select a plugin you want to improve, clone this issue and set a proper component ID Review the plugin page on Wiki and the GitHub README. If there is missing information in README, suggest 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, GitHub landing page will be updated. After that, a plugin release will be needed to make this documentation appear on the plugin site   Add Comment

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

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

Mark Waite updated an issue

Jenkins / JENKINS-59467 Issue Template: Migrate documentation from Wiki to GitHub

Change By: Mark Waite

<THIS IS A TEMPLATE ISSUE, PLEASE CLONE IT TO WORK ON A PLUGIN>

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.  By supporting such source in plugin site we provide good user experience to Jenkins users who look for 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. It gives an opportunity to review the documentation Documentation changes will be reviewed as part of pull requests and to add documentation contributor recognition contributors will be recognized , especially if the story is when combined with [Release Drafter|https://github.com/jenkinsci/.github/blob/master/.github/release-drafter.adoc]. So, we We recommend all plugins to migrate documentation to GitHub. Steps: * Select a plugin you want to improve, clone this issue and set a proper 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, suggest 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. After that, a The next time the plugin release will be needed to make this releases, the documentation will appear on the plugin site https://plugins.jenkins.io/.

Add Comment

[zbynek1729@gmail.com (JIRA)]

Zbynek Konecny updated an issue

Jenkins / JENKINS-59467 Issue Template: Migrate documentation from Wiki to GitHub

Change By: Zbynek Konecny

<THIS IS A TEMPLATE ISSUE, PLEASE CLONE IT TO WORK ON A PLUGIN> 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/.

Add Comment