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

Migrate workflow-cps-global-lib-plugin documentation from Wiki to GitHub

    XMLWordPrintable

    Details

    • Similar Issues:

      Description

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

       

        Attachments

          Activity

          darinpope Darin Pope created issue -
          darinpope Darin Pope made changes -
          Field Original Value New Value
          Epic Link WEBSITE-637 [ 201403 ]
          darinpope Darin Pope made changes -
          Assignee Darin Pope [ darinpope ]
          darinpope Darin Pope made changes -
          Description <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/.

           
          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 Oleg Nenashev made changes -
          Component/s workflow-cps-global-lib-plugin [ 21714 ]
          Component/s other [ 15490 ]
          oleg_nenashev Oleg Nenashev made changes -
          Epic Link WEBSITE-637 [ 201403 ] INFRA-2328 [ 202981 ]
          markewaite Mark Waite made changes -
          Assignee Darin Pope [ darinpope ] Sladyn Nunes [ sladyn98 ]
          markewaite Mark Waite made changes -
          Remote Link This issue links to "PR 89 - plugin migrate docs to GitHub (Web Link)" [ 24350 ]
          markewaite Mark Waite made changes -
          Status Open [ 1 ] In Progress [ 3 ]
          markewaite Mark Waite made changes -
          Status In Progress [ 3 ] In Review [ 10005 ]

            People

            Assignee:
            sladyn98 Sladyn Nunes
            Reporter:
            darinpope Darin Pope
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated: