Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor core documentation to make it relevant for modern Spring applications [SPR-17642] #22171

Open
spring-projects-issues opened this issue Jan 7, 2019 · 2 comments
Assignees
Milestone

Comments

@spring-projects-issues
Copy link
Collaborator

@spring-projects-issues spring-projects-issues commented Jan 7, 2019

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
Copy link
Collaborator Author

@spring-projects-issues spring-projects-issues commented Jan 8, 2019

Sébastien Deleuze commented

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

@sdeleuze
Copy link
Contributor

@sdeleuze sdeleuze commented Sep 9, 2019

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 sdeleuze modified the milestones: 5.x Backlog, 5.3 M1 Sep 9, 2019
@jhoeller jhoeller modified the milestones: 5.3 M1, 5.3 M2 Feb 24, 2020
@jhoeller jhoeller modified the milestones: 5.3 M2, 5.3 RC1 Jun 23, 2020
@jhoeller jhoeller modified the milestones: 5.3 RC1, 5.3 RC2 Aug 24, 2020
@sdeleuze sdeleuze modified the milestones: 5.3 RC2, 5.x Backlog Sep 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants