spring-cloud / spring-cloud-build

Common build concerns, shared plugin configuration, etc. for Spring Cloud modules
Apache License 2.0
191 stars 284 forks source link

Add Javadoc on many Spring Cloud Core project sites #69

Closed dsiegal closed 5 years ago

dsiegal commented 6 years ago

Go to the home page of Spring Cloud Task project. In the documentation table on the right, the API links points to the Javadoc for Spring Cloud Task. This is what I would expect.

Yet in most of the other Spring Cloud projects I've seen so far, the API links point to a wrong resource (either the the associated Github repo or the Reference documentation). For example, go to Spring Cloud Security. The API links for releases 1.1.4, 1.1.5 and 1.2.1 point to the Github repo. The API links for 1.2.2 and 1.2.3 point to the Reference documentation. Similar behavior for (e.g. Spring Cloud Config, Spring Cloud Netflix, Spring Cloud AWS, etc.

The convention for working projects (throughout the Spring ecosystem) seems to be that javadoc is hosted at https://docs.spring.io/, e.g.: https://docs.spring.io/spring-boot, https://docs.spring.io/spring-cloud-task. For the errant sites above, there is no such javadoc, e.g.: https://docs.spring.io/spring-cloud-config, https://docs.spring.io/spring-cloud-netflix, https://docs.spring.io/spring-cloud-aws, etc., all produce 404s.

It would be helpful if all spring projects generated and deployed javadoc to docs.spring.io, with correct links to them on their associated project sites.

spencergibb commented 6 years ago

Spring Cloud Core projects (Build, Netflix, Commons, Config, Bus, Release, Aws, Cloudfoundry, Consul, Contract, Gateway, Security, Sleuth, Vault, Zookeeper, Pipelines) do not publish documents to http://docs.spring.io.

We're thinking of setting links to javadoc.io like this: https://www.javadoc.io/doc/org.springframework.cloud/spring-cloud-commons/1.2.3.RELEASE

Spring Cloud Task and Spring Cloud Stream are not part of core and have separate project teams, you'll need to submit separate issues there.

garyrussell commented 6 years ago

SC Task and SC Stream publish API artifacts already (like most Spring projects), so there is no need to open issues for those projects.

spencergibb commented 5 years ago

Duplicate of #42