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

Extend/refactor jenkinsdoc macro on the site to support core, plugins AND (new) component Javadoc

    XMLWordPrintable

    Details

    • Similar Issues:

      Description

      https://github.com/jenkins-infra/jenkins.io/blob/master/STYLEGUIDE.adoc#javadoc-links does not support links to component Javadoc in http://javadoc.jenkins.io/component/

      The current syntax probably needs to be changed notably to support both plugins and components.

      The code is here: https://github.com/jenkins-infra/asciidoctor-jenkins-extensions/blob/master/lib/asciidoctor/jenkins/extensions/javadoc-link.rb

        Attachments

          Issue Links

            Activity

            danielbeck Daniel Beck created issue -
            zbynek Zbynek Konecny made changes -
            Field Original Value New Value
            Description [https://github.com/jenkins-infra/jenkins.io/blob/master/STYLEGUIDE.adoc#javadoc-links] does not support links to component Javadoc in [http://javadoc.jenkins.io/component/]

            The current syntax probably needs to be changed notably to support both plugins and components.
            [https://github.com/jenkins-infra/jenkins.io/blob/master/STYLEGUIDE.adoc#javadoc-links] does not support links to component Javadoc in [http://javadoc.jenkins.io/component/]

            The current syntax probably needs to be changed notably to support both plugins and components.

            The code is here: https://github.com/jenkins-infra/asciidoctor-jenkins-extensions/blob/master/lib/asciidoctor/jenkins/extensions/javadoc-link.rb
            Hide
            danielbeck Daniel Beck added a comment -

            I wonder whether adding jenkinsdoc:component:cname:Class[] and jenkinsdoc:plugin:pname:Class[] (+ all other suffix variants) would do it.

            • no prefix is core (exists)
            • One prefix is a plugin name (exists)
            • Two prefixes separated by : is type (plugin or component) and its name (new)

            jenkinsdoc:core:Class[] or jenkinsdoc:jenkins-core:Class[] might work with additional special handling. E.g. the latter name is already effectively reserved in the https://jenkins.io/doc/developer/extensions/ URL space.

            Show
            danielbeck Daniel Beck added a comment - I wonder whether adding jenkinsdoc:component:cname:Class[] and jenkinsdoc:plugin:pname:Class[] (+ all other suffix variants) would do it. no prefix is core (exists) One prefix is a plugin name (exists) Two prefixes separated by : is type (plugin or component) and its name (new) jenkinsdoc:core:Class[] or jenkinsdoc:jenkins-core:Class[] might work with additional special handling. E.g. the latter name is already effectively reserved in the https://jenkins.io/doc/developer/extensions/ URL space.
            zbynek Zbynek Konecny made changes -
            Assignee Zbynek Konecny [ zbynek ]
            Status To Do [ 10003 ] In Progress [ 3 ]
            zbynek Zbynek Konecny made changes -
            Assignee Zbynek Konecny [ zbynek ] Tim Jacomb [ timjacomb ]
            zbynek Zbynek Konecny made changes -
            Remote Link This issue links to "PR (Web Link)" [ 23908 ]
            zbynek Zbynek Konecny made changes -
            Remote Link This issue links to "jenkins.io PR (Web Link)" [ 24010 ]
            zbynek Zbynek Konecny made changes -
            Resolution Fixed [ 1 ]
            Status In Progress [ 3 ] Done [ 10004 ]

              People

              Assignee:
              timjacomb Tim Jacomb
              Reporter:
              danielbeck Daniel Beck
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: