spring-projects / spring-projects/spring-security
Document non Servlet code separately
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 6.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 52
Description
The main reference documentation has a servlet section https://docs.spring.io/spring-security/reference/servlet/index.html, however if you are building code that does not need servlet access or cannot access servlet applications such as quartz, some unit tests, cli applications, event handlers (e.g. rabbitmq), etc, the documentation for this is hidden or mixed in in a way that is hard to find and understand. A new section that explicitly documents using spring security in these contexts would be especially helpful.
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
Start with the servlet reference documentation at https://docs.spring.io/spring-security/reference/servlet/index.html and examine how non-servlet guidance is currently organized. Identify the relevant material for Quartz, unit tests, CLI applications, and event handlers such as RabbitMQ, then create a clearly separated section covering these contexts.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring
- Domain
- documentation, security
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100