playframework/playframework

docs related to security and caching actions could be improved

Open

#8,052 opened on Nov 29, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Scala (12,623 stars) (4,032 forks)batch import
good first issuehelp wantedtopic:documentation

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

Tech stack
javascala
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Play Framework knowledgeJava/Scala familiarity
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Review the current documentation page at https://www.playframework.com/documentation/2.6.x/JavaActionsComposition, specifically the note about Security.Authenticated and Cached annotations. Identify the gap in usage details for these annotations. Expand the documentation with clear examples and explanations, referencing the official API documentation for these classes. Consider also checking the corresponding Scala docs for consistency.