Uploaded image for project: 'Infrastructure'
  1. Infrastructure
  2. INFRA-1717

Javadoc Landing Page

    XMLWordPrintable

    Details

    • Similar Issues:

      Description

      User Experience is quite inconvenient with hidden information depending how you arrive on that service.

      Scenario 1, you get there via https://jenkins.io/doc/developer/javadoc/ and then it's kind of OK.
      Scenario 2, you get there via https://javadoc.jenkins.io and you have no way to know about https://javadoc.jenkins.io/component or https://javadoc.jenkins.io/plugin.

      It would be nice to have landing page similar to 'https://jenkins.io/doc/developer/javadoc/' when you arrive on javadoc.jenkins.io

      Several Links:

        Attachments

          Activity

          Hide
          lloydchang Lloyd Chang added a comment - - edited

          Hi Olivier Vernin Cc Martin d'Anjou — FYI: I referenced this task in a suggested edit for Jenkins Google Summer of Code project proposal: Automatic Spec Generator for Jenkins REST API at https://docs.google.com/document/d/14N6kCShmxy4SumT0khuEFxXYZE4v1_bimK66PJuBHzM/

          While Javadoc isn’t Rest API, user experience concerns described in INFRA-1717 for Javadoc Landing Page could be re-considered when determining where to publish Rest API accordingly

          Show
          lloydchang Lloyd Chang added a comment - - edited Hi Olivier Vernin  Cc Martin d'Anjou — FYI: I referenced this task in a suggested edit for Jenkins Google Summer of Code project proposal: Automatic Spec Generator for Jenkins REST API at https://docs.google.com/document/d/14N6kCShmxy4SumT0khuEFxXYZE4v1_bimK66PJuBHzM/ While Javadoc isn’t Rest API, user experience concerns described in INFRA-1717 for Javadoc Landing Page could be re-considered when determining where to publish Rest API accordingly
          Hide
          deepchip Martin d'Anjou added a comment -

          Lloyd Chang there is also the documentation improvement project where I mention this issue: https://docs.google.com/document/d/19hf1FSs7Y4z7YjfqjareqaWURpZ3Elkvh4XgLKdX6Ho/

           

          Show
          deepchip Martin d'Anjou added a comment - Lloyd Chang there is also the documentation improvement project where I mention this issue: https://docs.google.com/document/d/19hf1FSs7Y4z7YjfqjareqaWURpZ3Elkvh4XgLKdX6Ho/  

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            olblak Olivier Vernin
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Dates

              Created:
              Updated: