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

Support custom GitHub URLs as a source of plugin documentation

    Details

    • Type: Improvement
    • Status: Done (View Workflow)
    • Priority: Minor
    • Resolution: Fixed
    • Component/s: plugin-site
    • Labels:
      None
    • Similar Issues:

      Description

      Follow-up to the proposal from rsandell
       
      The easiest way would be to....

        Attachments

          Issue Links

            Activity

            Hide
            zbynek Zbynek Konecny added a comment -

            Oleg Nenashev why would we need hpi.pluginDocumentationUrl? We already have url (mostly pointing to wiki) and SCM url (pointing to github). Is there a usecase for 3 different URLs?

            Show
            zbynek Zbynek Konecny added a comment - Oleg Nenashev why would we need hpi.pluginDocumentationUrl? We already have url (mostly pointing to wiki) and SCM url (pointing to github). Is there a usecase for 3 different URLs?
            Hide
            oleg_nenashev Oleg Nenashev added a comment -

            We could indeed start from just processing <url> field.

            If it does not work, we can change the approach.

             

            Show
            oleg_nenashev Oleg Nenashev added a comment - We could indeed start from just processing <url> field. If it does not work, we can change the approach.  
            Hide
            oleg_nenashev Oleg Nenashev added a comment -

            I was a bith concerned about changing the root URL for plugins just to poin t to the docs, hence the complicated solution proposal.

            But indeed simple options can work as well

            Show
            oleg_nenashev Oleg Nenashev added a comment - I was a bith concerned about changing the root URL for plugins just to poin t to the docs, hence the complicated solution proposal. But indeed simple options can work as well
            Show
            oleg_nenashev Oleg Nenashev added a comment - http://mirror.serverion.com/jenkins/updates/current/plugin-documentation-urls.json  already offers some use-cases for testing, whether they are good or bad https://github.com/jenkinsci/sonar-quality-gates-plugin/blob/master/README.md https://github.com/jenkinsci/kryptowire-plugin/tree/master/docs https://github.com/jenkinsci/discord-notifier-plugin/blob/master/README.md *
            Show
            zbynek Zbynek Konecny added a comment - Oleg Nenashev  these look good now: https://plugins.jenkins.io/discord-notifier https://plugins.jenkins.io/sonar-quality-gates OK to close the ticket?
            Hide
            oleg_nenashev Oleg Nenashev added a comment -

            +1 for closing. Follow-up tickets can be created if any advanced behavior is needed

            Show
            oleg_nenashev Oleg Nenashev added a comment - +1 for closing. Follow-up tickets can be created if any advanced behavior is needed

              People

              • Assignee:
                zbynek Zbynek Konecny
                Reporter:
                oleg_nenashev Oleg Nenashev
              • Votes:
                1 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: