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

Daniel Beck ml at beckweb.net
Mon Jul 16 14:19:00 UTC 2018


> On 16. Jul 2018, at 13:55, Olblak <me at olblak.com> wrote:
> 
> 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?

Right, this has been a problem basically since we introduced plugin Javadocs.

Should be straightforward to rename the index file to index-core.html during generation, and creating a new index page similar to what's on Jenkins.io. This would retain all current URLs except for the index page, and thereby show users the available Javadocs. WDYT?



More information about the Jenkins-infra mailing list