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

jx-resources-plugin: Migrate documentation from Wiki to GitHub

XMLWordPrintable

      Wiki: https://wiki.jenkins.io/display/JENKINS/JX+Resources+Plugin

      GitHub: https://github.com/jenkinsci/jx-resources-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/.

       

            stopley Stephen Topley
            stopley Stephen Topley
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: