playframework / playframework/playframework.com
Add notice for Google searchers
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 44
- Forks
- 62
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 3
Description
Searching for Play documentation presents some problems for experienced programmers: they use Google, and following the usual route of "search terms web framework" doesn't work for Play, because it shows old versions or Google Play.
- https://twitter.com/kelleyrobinson/status/975376400025903104
- https://www.reddit.com/r/scala/comments/853v7q/play_rantframework_suggestion/
The best way to drill down into Play documentation is to use "site:playframework.com 2.6.x" on to the end of the google query, but that doesn't get exposed to people.
Looking at the "Referer" header to see if it includes "google" and then adding a modal dialog that says "Hi, we noticed you arrived on this page from Google, did you know adding site:playframework.com 2.6.x to your query will help find what you're looking for more easily?" may help.
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
No file or test is named. Start by locating the Play documentation pages and the request handling that can access the Referer header, then review how site notices or modal dialogs are implemented. Done means a Google-arriving visitor receives the proposed search guidance without disrupting other visitors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation, web-dev
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 28/100