spring-projects / spring-boot

Spring Boot
https://spring.io/projects/spring-boot
Apache License 2.0
74.4k stars 40.51k forks source link

Missing documentation for spring boot caching #33204

Closed MaximeBelanger closed 1 year ago

MaximeBelanger commented 1 year ago

Hello, the documentation regarding spring-boot caching seems to have been moved, while there are still some links to it.

In the Spring Caching Guide, in the 'Enable Caching' section, there is the following: Spring Boot automatically configures a suitable [CacheManager](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/cache/CacheManager.html) to serve as a provider for the relevant cache. See [the Spring Boot documentation](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-caching.html) for more detail.

The link converts to : https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#io.caching, but the section doesn't seem to exist anymore in the current version of the documentation.

Also, the Spring Boot Reference Documentation lists caching in the Core Features : "Profiles, Logging, Security, **Caching**, Spring Integration, Testing, and more." while there is no section on that subject in the core feature.

From my understanding, the Caching section has now moved here

Also, after reading the current documentation, two questions remain:

  1. What would be the current need to use spring-boot-starter-cache? It seems to be included in Spring Boot core, now.
  2. What would be the current quick way to get a Generic Spring Cache Provider Bean autoconfigured?
philwebb commented 1 year ago

I've raised https://github.com/spring-guides/gs-caching/issues/20 to fix the guide link and #33207 to fix the features link.

snicoll commented 1 year ago

@MaximeBelanger thanks for raising this. The links to the cache sections have been fixed. As for your questions, we don't use the issue tracker for that so please ask on StackOverflow. Caching was always a core framework (not Spring Boot) implementation. The starter brings spring-context-support which has additional cache provider implementations. I believe your question on the generic cache provider is described in the documentation, this section in particular.

If that doesn't help, please follow-up on StackOverflow and feel free to add a link to your question here.

MaximeBelanger commented 1 year ago

Thank you! For the sake of completeness regarding SB documentation, you could also remove the references to 'Caching' and 'Spring Integration' in the main page, since they are now documented in their specific sections. image

As for my questions, indeed I should have used SO. If anybody ends up here because of Google looking for the same answers, I was looking for the Simple cache, and not the Generic Cache; got confused between the two.

snicoll commented 1 year ago

For the sake of completeness regarding SB documentation, you could also remove the references to 'Caching' and 'Spring Integration' in the main page, since they are now documented in their specific sections.

I am a bit confused. That's exactly what I did, see the snapshot build https://docs.spring.io/spring-boot/docs/2.7.x-SNAPSHOT/reference/html/