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

Migrate badge plugin documentation from Wiki to GitHub

XMLWordPrintable

    • 1.9

      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-59646] Migrate badge plugin documentation from Wiki to GitHub

          Mark Waite created issue -
          Mark Waite made changes -
          Epic Link New: WEBSITE-637 [ 201403 ]
          Mark Waite made changes -
          Component/s New: badge-plugin [ 23455 ]
          Component/s Original: other [ 15490 ]
          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. 

          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: 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 (badge-plugin), 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 Waite made changes -
          Remote Link New: This issue links to "PR-22 Hacktoberfest use GitHub for plugin docs instead of Wiki (Web Link)" [ 23802 ]
          Mark Waite made changes -
          Status Original: Open [ 1 ] New: In Progress [ 3 ]
          Mark Waite made changes -
          Status Original: In Progress [ 3 ] New: In Review [ 10005 ]
          Mark Waite made changes -
          Assignee New: Mark Waite [ markewaite ]
          Mark Waite made changes -
          Resolution New: Fixed [ 1 ]
          Status Original: In Review [ 10005 ] New: Resolved [ 5 ]
          Mark Waite made changes -
          Status Original: Resolved [ 5 ] New: Fixed but Unreleased [ 10203 ]
          Oleg Nenashev made changes -
          Epic Link Original: WEBSITE-637 [ 201403 ] New: INFRA-2328 [ 202981 ]

            markewaite Mark Waite
            markewaite Mark Waite
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: