Uploaded image for project: 'Jenkins Website'
  1. Jenkins Website
  2. WEBSITE-637

Plugin Site Update: Documentation and Changelogs from GitHub

    XMLWordPrintable

    Details

    • Epic Name:
      PluginSite-GitHub-Integration
    • Similar Issues:

      Description

      Jenkins plugins steadily move to GitHub in order to enable Documentation-as-Code. Also, release Drafter changelog automation or CHANGELOG.md are pretty popular across plugins. It would be great to enable Jenkins Plugin Site to pull plugin information from the locations there so that Jenkins users get a better experience.

       Goals:

      • Plugin site can pull README.md from GitHub instead of Wiki for plugins
      • Plugin site can reference changelog URLs and, ideally, display the changelogs
      • Plugin site can display logos supplied by plugin metadata
      • + other topics TBD at the sub-project meeting

       

       

        Attachments

          Issue Links

          is related to

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. INFRA-2328 Documentation migration from Wiki to GitHub and jenkins.io

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • In Progress

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            oleg_nenashev Oleg Nenashev added a comment -

            CC Zbynek Konecny Gavin Mogan. Once INFRA-2220 is done, I will move the related tickets under the EPIC so that we can coordinate the multiple Work streams we have at the moment. If you are fine with that, I suggest using Documentation SIG as a base for the project. CC Mark Waite

             

            Show
            oleg_nenashev Oleg Nenashev added a comment - CC Zbynek Konecny Gavin Mogan . Once  INFRA-2220 is done, I will move the related tickets under the EPIC so that we can coordinate the multiple Work streams we have at the moment. If you are fine with that, I suggest using Documentation SIG as a base for the project. CC Mark Waite  
            Hide
            Permalink
            casz Joseph Petersen (old) added a comment -

            This is also another step towards not needing to host confluence

            Show
            casz Joseph Petersen (old) added a comment - This is also another step towards not needing to host confluence

              People

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

                Dates

                Created:
                Updated: