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.

Sign up for GitHub

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

Jump to bottom

Refactor configuration code samples to be more relevant for modern Spring applications #22171

Closed
spring-projects-issues opened this issue Jan 7, 2019 · 3 comments
Closed

Refactor configuration code samples to be more relevant for modern Spring applications #22171

spring-projects-issues opened this issue Jan 7, 2019 · 3 comments
Assignees
@sdeleuze
Labels
in: core Issues in core modules (aop, beans, core, context, expression) type: documentation A documentation task
Milestone
6.2.0-M1

Comments

@spring-projects-issues
Copy link
Collaborator

spring-projects-issues commented Jan 7, 2019 •
edited by sdeleuze

Current Spring Framework reference documentation can be challenging to use for people developing modern Spring Boot applications. To make it easier, this issue goal is to refactor the documentation in order to provide configuration snippets with tabs for Java, Kotlin and XML in order to avoid being exposed to XML configuration by default (except in dedicated sections).
@spring-projects-issues
Copy link
Collaborator Author

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 A documentation task label Jan 11, 2019
@spring-projects-issues spring-projects-issues added this to the 5.2 RC1 milestone Jan 11, 2019
This was referenced Jan 11, 2019
Closed
Closed
@jhoeller jhoeller modified the milestones: 5.2 M1, 5.2 RC1 Mar 23, 2019
@sdeleuze sdeleuze modified the milestones: 5.2 M3, 5.2 RC1 Jun 7, 2019
@sdeleuze sdeleuze modified the milestones: 5.2 RC1, 5.2 GA Jul 8, 2019
@sdeleuze sdeleuze modified the milestones: 5.2 GA, 5.x Backlog Sep 9, 2019
@sdeleuze
Copy link
Contributor

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
@jhoeller jhoeller modified the milestones: 6.x Backlog, 6.0.x Nov 11, 2021
@rstoyanchev rstoyanchev added the in: core Issues in core modules (aop, beans, core, context, expression) label Nov 24, 2021
@sdeleuze sdeleuze modified the milestones: 6.0.x, 6.1.x Feb 21, 2023
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Mar 7, 2024
@sdeleuze
Use code includes and tabs in connections.adoc
8450c8a 
See spring-projectsgh-22171
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Mar 7, 2024
@sdeleuze
Use code includes and tabs in connections.adoc
e6371b7 
See spring-projectsgh-22171
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Mar 7, 2024
@sdeleuze
Use code includes and tabs in connections.adoc
722199f 
See spring-projectsgh-22171
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Mar 7, 2024
@sdeleuze
Upgrade asciidoctor-extensions to 1.0.0-alpha.10
9fc8046 
See spring-projectsgh-22171
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Mar 7, 2024
@sdeleuze
Polishing
aa4282d 
See spring-projectsgh-22171
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Mar 8, 2024
@sdeleuze
Use code includes and tabs in jdbc/core.adoc
d2e55a2 
See spring-projectsgh-22171
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Mar 8, 2024
@sdeleuze
Use consistently snippet tags
db3c7a1 
See spring-projectsgh-22171
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Mar 8, 2024
@sdeleuze
Fix code snippet compilation error
5cac2ca 
See spring-projectsgh-22171
@sdeleuze sdeleuze changed the title Refactor core documentation to make it relevant for modern Spring applications Refactor configuration code samples to make it relevant for modern Spring applications Mar 12, 2024
@sdeleuze sdeleuze changed the title Refactor configuration code samples to make it relevant for modern Spring applications Refactor configuration code samples to be more relevant for modern Spring applications Mar 12, 2024
@sdeleuze sdeleuze mentioned this issue Mar 12, 2024
Closed
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Mar 12, 2024
@sdeleuze
Use code includes and tabs in embedded-database-support.adoc
8a67018 
See spring-projectsgh-22171
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Mar 12, 2024
@sdeleuze
Use code includes and tabs in mvc-controller/ann.adoc
460ffbc 
See spring-projectsgh-22171
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Mar 29, 2024
@sdeleuze
Use code includes and tabs in MVC Config documentation
91bb7d8 
This commit also refines the documentation related to
`@EnableWebMvc` in order to make it more relevant for modern Boot
applications.

See spring-projectsgh-22171
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Mar 29, 2024
@sdeleuze
Use code includes and tabs in MVC Config documentation
186e70c 
Additional fixes.

See spring-projectsgh-22171
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Apr 2, 2024
@sdeleuze
Refine @EnableWebFlux documentation
2320ca7 
This commit refines the documentation related to `@EnableWebFlux` in
order to make it more relevant for modern Boot applications.

See spring-projectsgh-22171
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Apr 2, 2024
@sdeleuze
Refine @EnableWebFlux documentation
bede619 
This commit refines the documentation related to `@EnableWebFlux` in
order to make it more relevant for modern Boot applications.

See spring-projectsgh-22171
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Apr 2, 2024
@sdeleuze
Polishing
8af3eb1 
See spring-projectsgh-22171
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Apr 8, 2024
@sdeleuze
Use code includes and tabs in date/time format documentation
6d61346 
See spring-projectsgh-22171
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Apr 8, 2024
@sdeleuze
Use code includes and tabs in date/time format documentation
5c8043d 
See spring-projectsgh-22171
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Apr 8, 2024
@sdeleuze
Use code includes and tabs in SpEL documentation
94050b3 
See spring-projectsgh-22171
snicoll added a commit that referenced this issue Apr 8, 2024
@snicoll
Consistent newline at the end of files
36636b0 
See gh-22171
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Apr 8, 2024
@sdeleuze
Use code includes and tabs in AOP documentation
515295e 
See spring-projectsgh-22171
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Apr 8, 2024
@sdeleuze
Use code includes and tabs in Regexp Pointcuts documentation
a471aa6 
See spring-projectsgh-22171
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Apr 9, 2024
@sdeleuze
Use code includes and tabs in WebSocket documentation
246f291 
See spring-projectsgh-22171
sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue Apr 9, 2024
@sdeleuze
Add missing dependency and remove warnings
c05b4bc 
See spring-projectsgh-22171
@sdeleuze sdeleuze mentioned this issue Apr 9, 2024
Closed
@sdeleuze
Copy link
Contributor

sdeleuze commented Apr 9, 2024

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 sdeleuze closed this as completed Apr 9, 2024
@sdeleuze sdeleuze mentioned this issue Apr 30, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sdeleuze sdeleuze

Labels
in: core Issues in core modules (aop, beans, core, context, expression) type: documentation A documentation task
Projects
None yet
Milestone
6.2.0-M1
Development

No branches or pull requests
4 participants
@sdeleuze @rstoyanchev @jhoeller @spring-projects-issues