spring-projects / spring-projects/spring-security
Update Documentation about CAS Authentication
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 6.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 52
Description
Describe the bug
The class org.springframework.security.cas.authentication.EhCacheBasedTicketCache has been removed in spring-security 6.x but is still referenced in the documentation.
To Reproduce
Go to https://docs.spring.io/spring-security/reference/servlet/authentication/cas.html#cas-pt and look for EhCacheBasedTicketCache.
EhCacheBasedTicketCache was deprecated in spring-security 5.6, then removed in spring-security 6.x.
This is the link for the github doccumentation:
https://github.com/spring-projects/spring-security/blob/2455feb37947dab10b79b1905be40046257370bb/docs/modules/ROOT/pages/servlet/authentication/cas.adoc?plain=1#L451-L463
Expected behavior
I believe the documentation can be updated to use SpringCacheBasedTicketCache instead.
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 docs/modules/ROOT/pages/servlet/authentication/cas.adoc and inspect the CAS ticket-cache section around lines 451–463. Search the documentation for EhCacheBasedTicketCache, update the referenced class to SpringCacheBasedTicketCache, and verify no obsolete references remain.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100