spring-projects / spring-projects/spring-security
Add a link to the beginner-friendly code example for storing authentication manually
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 6.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 52
Description
Expected Behavior
The NOTE section of Publish an AuthenticationManager bean can add a link to the code example of persisting authentication manually.
Current Behavior
Although the NOTE section of Publish an AuthenticationManager bean says it is your responsibility to save the authenticated user, there is currently no link to any code example for doing so for the sake of Spring Security beginners.
Context
To make documentation more beginner-friendly, docs should include more links to code examples.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the “Publish an AuthenticationManager bean” and “Store Authentication Manually” sections in the Spring Security reference documentation. Add the requested link from the note to the beginner-friendly manual persistence example, then verify that the link points to the intended section and renders correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring
- Domain
- authentication, documentation, security
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100