Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-59467

Issue Template: Migrate documentation from Wiki to GitHub

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

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

       

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

          Oleg Nenashev created issue -
          Oleg Nenashev made changes -
          Epic Link New: WEBSITE-637 [ 201403 ]
          Mark Waite made changes -
          Description Original: <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|https://github.com/jenkinsci/.github/blob/master/.github/release-drafter.adoc]. 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

           
          New: <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/.

           
          Zbynek Konecny made changes -
          Description Original: <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/.

           
          New: <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/.

           
          Oleg Nenashev made changes -
          Remote Link New: This issue links to "Announcement in the mailing list (Web Link)" [ 23729 ]
          Oleg Nenashev made changes -
          Remote Link Original: This issue links to "Announcement in the mailing list (Web Link)" [ 23729 ]
          Oleg Nenashev made changes -
          Remote Link New: This issue links to "Announcement in the developer mailing list (Web Link)" [ 23730 ]
          Oleg Nenashev made changes -
          Epic Link Original: WEBSITE-637 [ 201403 ] New: INFRA-2328 [ 202981 ]
          Oleg Nenashev made changes -
          Rank New: Ranked higher
          Oleg Nenashev made changes -
          Link New: This issue is related to INFRA-2328 [ INFRA-2328 ]
          Zainab Abubakar made changes -
          Link New: This issue relates to JENKINS-63067 [ JENKINS-63067 ]

            Unassigned Unassigned
            oleg_nenashev Oleg Nenashev
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated: