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

Issue Template: Migrate documentation from Wiki to GitHub

    Details

    • Similar Issues:

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

          Issue Links

            Activity

            There are no comments yet on this issue.

              People

              • Assignee:
                Unassigned
                Reporter:
                oleg_nenashev Oleg Nenashev
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated: