playframework / playframework/playframework
docs related to security and caching actions could be improved
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 12.6k
- Forks
- 4k
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 29
Description
On this page https://www.playframework.com/documentation/2.6.x/JavaActionsComposition there is this text:
Note: play.mvc.Security.Authenticated and play.cache.Cached annotations and the corresponding predefined Actions are shipped with Play. See the relevant API documentation for more information.
But the linked pages are very light on details. I can't tell how these are supposed to be used.
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 JavaActionsComposition page and follow its links to the Security.Authenticated and Cached API documentation. Clarify how these annotations and their predefined actions are intended to be used, and update the relevant documentation so readers can understand their usage without relying on the currently sparse API pages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100