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

Migrate Job Restrictions documentation from Wiki to GitHub

    XMLWordPrintable

Details

    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

        Activity

          I'd like to work on this. I'll be opening a PR for this today. GitHub handle is "eshack94".

          eshack94 Elijah Shackelford added a comment - I'd like to work on this. I'll be opening a PR for this today. GitHub handle is "eshack94".

          I've opened a PR for review for this doc migration from Wiki to GitHub: https://github.com/jenkinsci/job-restrictions-plugin/pull/49.

          Moved ticket to 'In Review' while I await feedback. Once feedback is received, I will act on that feedback to make needed changes and then hopefully get this merged.

          eshack94 Elijah Shackelford added a comment - I've opened a PR for review for this doc migration from Wiki to GitHub: https://github.com/jenkinsci/job-restrictions-plugin/pull/49 . Moved ticket to 'In Review' while I await feedback. Once feedback is received, I will act on that feedback to make needed changes and then hopefully get this merged.

          People

            eshack94 Elijah Shackelford
            oleg_nenashev Oleg Nenashev
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated: