playframework / playframework/playframework.com
Use a modal dialog box for documentation warnings
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 44
- Forks
- 62
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 3
Description
There are several warning notices that kick into action on the site:
https://www.playframework.com/documentation/2.5.x/Home: "You are viewing the documentation for the 2.5.x release series. The latest stable release series is 2.6.x."
https://www.playframework.com/documentation/1.4.x/home: "You are viewing the documentation for Play 1. The documentation for Play 2 is here."
These warning are above the search bar, and have visual styling that is hard to distinguish from the rest of the page. It would be better to turn this into a modal dialog that covers the rest of the page and must be explicitly clicked through and ignored (potentially with cookie for persistent setting) so that it can't be skipped past.
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 by inspecting the warning notices on the 2.5.x Home and 1.4.x home documentation pages linked in the issue. Determine where these notices are produced and how the site handles user preferences. Done means the warning is presented as a modal that must be explicitly dismissed, with any persistent setting matching the agreed behavior.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100