[Jenkins-infra] Javadoc.jenkins.io as a standalone service

Olblak me at olblak.com
Mon Jul 16 11:55:11 UTC 2018

I recently updated https://javadoc.jenkins.io in order to

1. Update it more frequently [INFRA-1600]
2. Enable HTTPS support  [INFRA-1387]
3. Move it to Azure [INFRA-1426]

But I also found the UX 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.

Is there any other way to access the javadoc?

Maybe I am the only one but instinctively I would follow scenario 2 and expect 'jenkins.io/doc/developer/javadoc' to be the same than 'javadoc.jenkins.io'.
I would also expect javadoc to be a standalone service, where everything is defined from https://github.com/jenkins-infra/javadoc without having to go on github.com/jenkins-infra/jenkins.io.

What's your thought about this?

More information about the Jenkins-infra mailing list