Uploaded image for project: 'Spring Integration'
  1. Spring Integration
  2. INT-4406

Missing Javadoc on many Spring Cloud project sites

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Minor
    • Resolution: Invalid
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None

      Description

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

      Yet in many 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.
      I've found similar behavior at other Spring Cloud projects I've checked (e.g. Spring Cloud Config, Spring Cloud Netflix, Spring Cloud AWS, etc.

      Note: not all spring cloud sites are broken this way; Spring Cloud Task works as expected.

      The convention seems to be that javadoc is hosted at https://docs.spring.io/<project-name>, 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.

      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.

        Attachments

          Activity

            People

            • Assignee:
              grussell Gary Russell
              Reporter:
              Baobob David Siegal
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: