playframework / playframework/playframework
Doc Issue: ScalaHttpFilters.md links for filter component classes are broken
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 12.6k
- Forks
- 4k
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 29
Description
The links under https://www.playframework.com/documentation/2.8.x/ScalaHttpFilters#Using-filters are broken.
The links for these components:
- GzipFilterComponents
- CSRFComponents
- CORSComponents
- SecurityHeadersComponents
- AllowedHostsComponents
https://www.playframework.com/documentation/2.8.x/api/scala/play/index.html seems to be missing the classes from play-filters-helpers jar
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 ScalaHttpFilters.md section at the documented Using-filters URL and compare its five component links with the generated Scala API page. Confirm how the play-filters-helpers classes are expected to appear, then make the links resolve to GzipFilterComponents, CSRFComponents, CORSComponents, SecurityHeadersComponents, and AllowedHostsComponents.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100