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

Improve reference documentation on Resources #26447

Closed
3 tasks done
sbrannen opened this issue Jan 26, 2021 · 2 comments
Closed
3 tasks done

Improve reference documentation on Resources #26447

sbrannen opened this issue Jan 26, 2021 · 2 comments
Assignees
@sbrannen
Labels
in: core Issues in core modules (aop, beans, core, context, expression) type: documentation A documentation task
Milestone
5.3.4

Comments

@sbrannen
Copy link
Member

sbrannen commented Jan 26, 2021 •
edited
Loading

Status Quo

As discussed in #26443, the Resources section of the reference documentation is very outdated, focusing primarily on XML-based configuration of the resource locations for the ApplicationContext and not directly mentioning ResourcePatternResolver at all.

Deliverables

  • Document the ResourcePatternResolver API as an alternative to the ResourceLoader API.
  • Document PathResource as a built-in Resource.
  • Consider providing examples where resources are injected into fields of type Resource or Resource[] in @Configuration classes or annotated components via @Autowired or @Value semantics.
@sbrannen sbrannen added type: documentation A documentation task in: core Issues in core modules (aop, beans, core, context, expression) labels Jan 26, 2021
@sbrannen sbrannen added this to the 5.3.4 milestone Jan 26, 2021
@sbrannen sbrannen self-assigned this Jan 26, 2021
@sbrannen sbrannen mentioned this issue Jan 26, 2021
Closed
sbrannen added a commit that referenced this issue Feb 15, 2021
@sbrannen
Polish Resources section of the reference manual
ff43731 
See gh-26447
sbrannen added a commit that referenced this issue Feb 15, 2021
@sbrannen
Update Resource interface in the reference manual
7225238 
See gh-26447
sbrannen added a commit that referenced this issue Feb 15, 2021
@sbrannen
Document PathResource as a built-in Resource in the reference manual
c26087e 
See gh-26447
sbrannen added a commit that referenced this issue Feb 16, 2021
@sbrannen
Polish ResourcePatternResolver docuementation in the reference manual
a315abf 
See gh-26447
sbrannen added a commit that referenced this issue Feb 16, 2021
@sbrannen
Remove Kotlin "translations" of Java APIs in the reference manual
829000d 
See gh-26447
sbrannen added a commit that referenced this issue Feb 16, 2021
@sbrannen
Link to all built-in Resource implementations
1e57e57 
See gh-26447
sbrannen added a commit that referenced this issue Feb 16, 2021
@sbrannen
Polish Resources section of the reference manual
ac58614 
See gh-26447
sbrannen added a commit that referenced this issue Feb 17, 2021
@sbrannen
Document @value support for Resource/Resource[] injection in ref docs
8776139 
See gh-26447
@sbrannen
Copy link
Member Author

@nightswimmings, I've completed all planned changes to the Resources section of the reference manual.

Please take a look and let us know if we've addressed all of the concerns you raised in #26443.

@nightswimmings
Copy link

@sbrannen Much clearer now, thanks!!

lxbzmy pushed a commit to lxbzmy/spring-framework that referenced this issue Mar 26, 2022
@sbrannen @lxbzmy
Polish Resources section of the reference manual
a61bc70 
See spring-projectsgh-26447
lxbzmy pushed a commit to lxbzmy/spring-framework that referenced this issue Mar 26, 2022
@sbrannen @lxbzmy
Update Resource interface in the reference manual
3ab2ee6 
See spring-projectsgh-26447
lxbzmy pushed a commit to lxbzmy/spring-framework that referenced this issue Mar 26, 2022
@sbrannen @lxbzmy
Document PathResource as a built-in Resource in the reference manual
4d686aa 
See spring-projectsgh-26447
lxbzmy pushed a commit to lxbzmy/spring-framework that referenced this issue Mar 26, 2022
@sbrannen @lxbzmy
Document ResourcePatternResolver in the reference manual
538603c 
Closes spring-projectsgh-26447
lxbzmy pushed a commit to lxbzmy/spring-framework that referenced this issue Mar 26, 2022
@sbrannen @lxbzmy
Polish ResourcePatternResolver docuementation in the reference manual
998f6b3 
See spring-projectsgh-26447
lxbzmy pushed a commit to lxbzmy/spring-framework that referenced this issue Mar 26, 2022
@sbrannen @lxbzmy
Remove Kotlin "translations" of Java APIs in the reference manual
3d42aa7 
See spring-projectsgh-26447
lxbzmy pushed a commit to lxbzmy/spring-framework that referenced this issue Mar 26, 2022
@sbrannen @lxbzmy
Link to all built-in Resource implementations
da3af7f 
See spring-projectsgh-26447
lxbzmy pushed a commit to lxbzmy/spring-framework that referenced this issue Mar 26, 2022
@sbrannen @lxbzmy
Polish Resources section of the reference manual
1f9ad63 
See spring-projectsgh-26447
lxbzmy pushed a commit to lxbzmy/spring-framework that referenced this issue Mar 26, 2022
@sbrannen @lxbzmy
Document @value support for Resource/Resource[] injection in ref docs
8783f4d 
See spring-projectsgh-26447
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sbrannen sbrannen

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

No branches or pull requests
2 participants
@sbrannen @nightswimmings