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

          Mayank added a comment -

          Hey oleg_nenashev , is this issue open to be worked on.

          Thank you.

          Mayank added a comment - Hey oleg_nenashev , is this issue open to be worked on. Thank you.

          Mark Waite added a comment - - edited

          mayank77maruti as noted in the issue description:

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

          This is not an issue that will be worked. It is an issue that contributors clone when they need to work on a plugin that they choose. There are still some plugins that need their documentation transitioned from the Jenkins Wiki to GitHub. For example, you could create a copy of this issue and assign it to the JDK_Parameter plugin. Then you would follow the instructions to migrate the documentation from the Wiki to GitHub.

          Mark Waite added a comment - - edited mayank77maruti as noted in the issue description: <THIS IS A TEMPLATE ISSUE, PLEASE CLONE IT TO WORK ON A PLUGIN> This is not an issue that will be worked. It is an issue that contributors clone when they need to work on a plugin that they choose. There are still some plugins that need their documentation transitioned from the Jenkins Wiki to GitHub. For example, you could create a copy of this issue and assign it to the JDK_Parameter plugin . Then you would follow the instructions to migrate the documentation from the Wiki to GitHub.

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

              Created:
              Updated: