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
Labels
in: core type: documentation
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.

@spring-projects-issues spring-projects-issues added the type: documentation label Jan 11, 2019
@spring-projects-issues spring-projects-issues added this to the 5.2 RC1 milestone Jan 11, 2019
@jhoeller jhoeller removed this from the 5.2 M1 milestone Mar 23, 2019
@jhoeller jhoeller added this to the 5.2 RC1 milestone Mar 23, 2019
@sdeleuze sdeleuze removed this from the 5.2 M3 milestone Jun 7, 2019
@sdeleuze sdeleuze added this to the 5.2 RC1 milestone Jun 7, 2019
@sdeleuze sdeleuze removed this from the 5.2 RC1 milestone Jul 8, 2019
@sdeleuze sdeleuze added this to the 5.2 GA milestone Jul 8, 2019
@sdeleuze sdeleuze removed this from the 5.2 GA milestone Sep 9, 2019
@sdeleuze sdeleuze added this to the 5.x Backlog milestone Sep 9, 2019
@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 removed this from the 5.x Backlog milestone Sep 9, 2019
@sdeleuze sdeleuze added this to the 5.3 M1 milestone Sep 9, 2019
@jhoeller jhoeller removed this from the 5.3 M1 milestone Feb 24, 2020
@jhoeller jhoeller added this to the 5.3 M2 milestone Feb 24, 2020
@jhoeller jhoeller removed this from the 5.3 M2 milestone Jun 23, 2020
@jhoeller jhoeller added this to the 5.3 RC1 milestone Jun 23, 2020
@jhoeller jhoeller removed this from the 5.3 RC1 milestone Aug 24, 2020
@jhoeller jhoeller added this to the 5.3 RC2 milestone Aug 24, 2020
@sdeleuze sdeleuze removed this from the 5.3 RC2 milestone Sep 21, 2020
@sdeleuze sdeleuze added this to the 5.x Backlog milestone Sep 21, 2020
@jhoeller jhoeller removed this from the 6.x Backlog milestone Nov 11, 2021
@jhoeller jhoeller added this to the 6.0.x milestone Nov 11, 2021
@rstoyanchev rstoyanchev added the in: core label Nov 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: core type: documentation
Projects
None yet
Development

No branches or pull requests

4 participants