spring-framework icon indicating copy to clipboard operation
spring-framework copied to clipboard

Refactor core documentation to make it relevant for modern Spring applications

Open spring-projects-issues opened this issue 7 years ago • 2 comments

Sébastien Deleuze opened SPR-17642 and commented

Current Spring Framework core documentation is very hard to use for people developing modern Spring Boot applications. To make it easier I think we should organize it with distinct sections:

  • Section about what is common to XML, JavaConfig and functional beans
  • Section specific to XML
  • Section specific to JavaConfig
  • Section specific to functional beans (#19615)

The JavaConfig section should also be reworked to make it mostly relevant for Spring Boot application and isolate documentation not relevant for Spring Boot to make it less confusing.


Issue Links:

  • #19615 Document functional configuration style
  • #12255 Provide proper @Value documentation in the reference documentation

spring-projects-issues avatar Jan 07 '19 10:01 spring-projects-issues

Sébastien Deleuze commented

We can also probably update this kind of statement since usage and best practices have evolved.

spring-projects-issues avatar Jan 08 '19 13:01 spring-projects-issues

I have not the bandwidth to do that for Spring Framework 5.2, but that's probably a good candidate for Spring Framework 5.3.

sdeleuze avatar Sep 09 '19 08:09 sdeleuze

A significant part of the documentation has been updated, so let's close this issue and get feedback after 6.2.0-M1 release and follow-up with #32429 and #32600.

sdeleuze avatar Apr 09 '24 11:04 sdeleuze