spring-projects / spring-projects/spring-security
Improve Documentation
Open
@jzheaux is already working on this.
Since Jan 10, 2023.
in: docs
type: enhancement
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 6.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 52
Description
Each section of Spring Security's reference manual should be reviewed in consideration of the following structure:
- Start with "what to do"
- show code samples that cover 90% of applications
- show testing what was added
- link to relevant Spring Security Sample commit diffs
- link to the next relevant documentation step(s)
- Follow with "how it works"
- use diagrams to explain workflows
- include tradeoffs and security principles
- show tabular information
- Follow with 10% usage
and the following principles:
- Linked "what to dos" should make progressive sense together
- Use headers for contextual linking
- Favor the latest recommendations
- Explain deprecated recommendations relative to the benefits of the latest ones
- Not have outdated recommendations
- Use XML/Java/Kotlin tabs
- Link to other Spring projects; Framework, Data, Boot, MVC, etc.
Here are the sections that are planned so far:
- #13062
- #12601
- #13088
- #13089
- #13090
- OAuth 2.0 Resource Server
- #14944
- Authentication
- Response Headers
- Firewall
- Remember Me
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.
Assessment
This issue has not been assessed yet.