search

spring-attic / spring-cloud-gcp

Integration for Google Cloud Platform APIs with Spring
Apache License 2.0
704 stars 694 forks source link

Docs: Cloud Firestore Example Link Broken #2544

Closed jamesward closed 3 years ago

jamesward commented 3 years ago

https://cloud.spring.io/spring-cloud-static/spring-cloud-gcp/1.2.0.M1/#_sample_14

Points to: https://github.com/spring-cloud-gcp/spring-cloud-gcp-samples/spring-cloud-gcp-firestore-sample

meltsufin commented 3 years ago

This is a really old version of the project, which no one should really be using. How did you land on that version of the refdoc? We're on 1.2.5.RELEASE right now, and the link is correct there. https://docs.spring.io/spring-cloud-gcp/docs/1.2.5.RELEASE/reference/html/#samples-3

So, I don't know if it's worth fixing.

jamesward commented 3 years ago

Ah! That is where google took me and I didn't see that I was on an older version. Whoops. I wonder if we could have a message like Play does: https://www.playframework.com/documentation/2.6.x/JavaHome

You are viewing the documentation for the 2.6.x release series. The latest stable release series is 2.8.x.
meltsufin commented 3 years ago

That would be nice indeed. @artembilan Is this something that the Spring team has thought about?

artembilan commented 3 years ago

Well, our docs are generated as independent static resources and we definitely are not going to regenerate every single old version when we release a new one.

That Play Framework sample is not about comparing apples with apples and what I see so far is just embedded docs directly into their original site. We have something like that when you really jump into project page: https://spring.io/projects/spring-cloud-gcp#learn, so you can see what versions are supported and what is the latest stable.

Probably @bclozel has some thought on the matter...

bclozel commented 3 years ago

While we could do something on pages hosted on docs.spring.io, cloud.spring.io is a different matter as it's hosted on github pages. Regenerating the docs is clearly a hard problem, but maybe replacing old versions with HTML redirects is doable here https://github.com/spring-cloud/spring-cloud-static/tree/gh-pages ?

meltsufin commented 3 years ago

I didn't even realize that @jamesward's link was from coming from gh-pages vs. our published docs are on docs.spring.io. Which should be the official hosting? Are both used?

jamesward commented 3 years ago

Maybe an iframe that reads the parent URL could render a message like Play does.

meltsufin commented 3 years ago

I'm closing this because going forward our home is at https://github.com/GoogleCloudPlatform/spring-cloud-gcp and we have a good control of publishing documentation there on gh-pages.