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

Migrate mstest plugin documentation from Wiki to GitHub

XMLWordPrintable

      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-63067] Migrate mstest plugin documentation from Wiki to GitHub

          Zainab Abubakar created issue -
          Zainab Abubakar made changes -
          Epic Link New: INFRA-2328 [ 202981 ]
          Zainab Abubakar made changes -
          Description Original: <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/.

                      		New: 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/].

           
          Zainab Abubakar made changes -
          Component/s New: mstest-plugin [ 15619 ]
          Component/s Original: other [ 15490 ]
          Assignee New: Zainab Abubakar [ zaycodes ]
          Labels Original: hacktoberfest newbie-friendly New: documentation wiki-migration
          Zainab Abubakar made changes -
          Status Original: Open [ 1 ] New: In Progress [ 3 ]
          Zainab Abubakar made changes -
          Link New: This issue relates to INFRA-2328 [ INFRA-2328 ]
          Zainab Abubakar made changes -
          Link New: This issue relates to JENKINS-59646 [ JENKINS-59646 ]
          Zainab Abubakar made changes -
          Link New: This issue relates to JENKINS-59467 [ JENKINS-59467 ]
          Zainab Abubakar made changes -
          Remote Link New: This issue links to "Github Pull Request (Web Link)" [ 25325 ]
          Zainab Abubakar made changes -
          Remote Link Original: This issue links to "Github Pull Request (Web Link)" [ 25325 ]
          Zainab Abubakar made changes -
          Remote Link New: This issue links to "PR Migrating MSTest documentation from wiki to Github (Web Link)" [ 25326 ]

            zaycodes Zainab Abubakar
            zaycodes Zainab Abubakar
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: