spring-cloud / spring-cloud-netflix

Integration with Netflix OSS components
http://cloud.spring.io/spring-cloud-netflix/
Apache License 2.0
4.87k stars 2.44k forks source link

Broken documentation links #4293

Closed breun closed 1 month ago

breun commented 3 months ago

On https://spring.io/projects/spring-cloud-netflix#learn there are some broken links:

The link format for 4.1.x seems to be https://docs.spring.io/spring-cloud-netflix/reference/${version}, because these work:

I don't know what the correct links are for the 4.0.x versions.

fa11enangel commented 3 months ago

I've checked the documention. Not only links are broken, but the documentation is using outdated content:

There are not annotations anymore @EnableEurekaClient to enable service. See issue #4029

This URL is using wrong version: https://spring.io/projects/spring-cloud-netflix#overview This URL has an updated version without annotations: https://cloud.spring.io/spring-cloud-netflix/reference/html/#netflix-eureka-client-starter

This is the current content version in this project: https://github.com/spring-cloud/spring-cloud-netflix/blob/main/docs/src/main/asciidoc/sagan-index.adoc

OlgaMaciaszek commented 1 month ago

Thanks @breun, @fa11enangel. We've been changing the way our docs are generated and the site content is created and possibly things got mixed up. Will straighten it up.

@fa11enangel What do you mean by: "This URL is using wrong version: https://spring.io/projects/spring-cloud-netflix#overview"?

Also @EnableEurekaClient is not in the new docs. The problem (which we're fixing now) is that the links got to an older doc version. The docs for older versions will still contain it.

OlgaMaciaszek commented 1 month ago

Fixed.

fa11enangel commented 1 month ago

@OlgaMaciaszek if you check this URL https://spring.io/projects/spring-cloud-netflix#overview you see, that the example uses annotation @EnableEurekaClient to inject eureka client functionality in the Application class.

But this annonation @EnableEurekaClient was removed and doesn't exist anymore. You did the change in https://github.com/spring-cloud/spring-cloud-netflix/issues/4029 .

Should I open a new bug for this? It is not a link issue but outdated information maybe. I can't see how the content on spring.io is built.

OlgaMaciaszek commented 1 month ago

Thanks @fa11enangel, i see. Will fix it now.

fa11enangel commented 1 month ago

There is another mention in the description above example:

As long as Spring Cloud Netflix and Eureka Core are on the classpath any Spring Boot application with @EnableEurekaClient will try to contact a Eureka server