playframework/playframework.com

The Play Framework website

Play Framework - The High Velocity Web Framework

The Play Framework combines productivity and performance making it easy to build scalable web applications with Java and Scala. Play is developer friendly with a "just hit refresh" workflow and built-in testing support. With Play, applications scale predictably due to a stateless and non-blocking architecture. By being RESTful by default, including assets compilers, JSON & WebSocket support, Play is a perfect fit for modern web & mobile applications.

Learn More

• www.playframework.com
• Download
• Install
• Create a new application
• Play for Scala developers
• Play for Java developers
• Build from source
• Search or create issues
• Get help
• Contribute

Sponsors & Backers

If you find Play useful for work, please consider asking your company to support this Open Source project by becoming a sponsor.
You can also individually sponsor the project by becoming a backer.

Thank you to our premium sponsors!

Thank you to all our backers!

License

Copyright (C) from 2022 The Play Framework Contributors https://github.com/playframework, 2011-2021 Lightbend Inc. https://www.lightbend.com

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

playframework.com's Issues

I'd like to add link to My user group in home page

Hi.!

I'm Lawrence from korea republic of.
I'd like to add link to My user group in home page.
The page is "https://www.playframework.com/documentation/$(VERSION)/PlayUserGroups"

How to add it?

Please Help me :)

"Browse versions" links in documentation pages should point to the current page in chosen version

When one is on page "ScalaWS" for version 2.3.x link here and opens the dropdown list on the right-hand side of the page and clicks on version 2.4.x, one is not taken to page "ScalaWS" for version 2.4.x (this would be the correct link), but to the main page for version 2.4.x (this link).

I know that there will be times when a given page is not available in the target version but we could redirect tthe user to the home page only in those cases when there isn't a matching version. I think this is what most users expect.

Fix header size

Link with anchor: https://www.playframework.com/documentation/2.6.x/Migration26#play.api.libs.concurrent.Execution-is-deprecated

Maybe it should be replaced with ### in markup instead of ##?

Cumbersome to click the dropdown button

On the documentation page the dropdown button is a bit cumbersome. You have to directly click the arrow-down symbol to trigger the dropdown otherwise it wont work. Have a look this screenshot, I added a blue overlay above the icon which triggers the action. As you can see right and left from the icon no click will be triggered.

I am using Chrome 56 - but I did recognise this behaviour at least 2 years ago already.
If you don't know this someone may think the site is broken - actually it toke me a few moments to figure out to exactly click the arrow to make it work.
For newcomers this isn't a really good user experience.

Use canonical link in playframework documentation

From playframework/playframework#5256:

Whenever I do a search for the documentation I get results for old versions like 2.0 instead of 2.4. It'd be really nice to fix this

http://stackoverflow.com/questions/29603839/versioned-urls-how-can-i-tell-search-engines-about-more-recent-versions-of-the

Source code link broken for non-playframework documentation

The source code link at the bottom of the documentation seems to assume it is in the playframework repo, for example:

• PlaySlick: https://github.com/playframework/playframework/blob/2.5.x/documentation/manual/working/scalaGuide/main/sql/slick/PlaySlick.md
• ScalaAnorm: https://github.com/playframework/playframework/blob/2.5.x/documentation/manual/working/scalaGuide/main/sql/ScalaAnorm.md

Scrollbar issues detected in playframework.com

Originally reported at playframework/playframework#8136.

---

Today while surfing through playframework.com i discovered it has a scroll bar problem.
whereby the issue is the scroll bar of the website at a point ,doesn't move with the page simultaneously
below is the problem.
video https://youtu.be/Cb3v4-2XcXU
Thank you.
I hope my findings would be helpful.
Operating system : Windows 8.1
Browser used: Google chrome Version 63.0.3239.84 (Official Build) (64-bit)

---

Posted on Utopian.io - Rewarding Open Source Contributors

Improve the download page

Future reference:

1. Make the path clear for them to run their first app. Explain what the sample app is and what it illustrates, make sure that once they've downloaded it, they can easily find the instructions to run it. Unify the path in the doc, so that regardless of whether they start from the "Download" page or from the doc, they do not get confused about what to do next.

2. Provide an overview of Play that is the next level down from the high level benefits that are well-explained already on the website.
   Describe things like where Play fits into a complete solution (a few illustrations would be great), what is the typical development process for creating a Play app, and where they can go next to learn more. Maybe you have some of this content already in the doc, but it needs to be pulled up front where new users can more readily find it?

Play module directory

Now that "modules" are a thing people are interested in in 2.x, we might want to have the /modules page use/reference the module directory we have at https://www.playframework.com/documentation/2.4.x/ModuleDirectory and the modules documentation at https://www.playframework.com/documentation/2.4.x/Modules.

I would actually prefer to move the 1.x modules page somewhere else altogether and maybe link to it from the new /modules page.

Deprecated usages in documentation

PlaySlick documentation contains deprecated configuration for slick:

# Orders database
slick.dbs.orders.driver="slick.driver.H2Driver$"
slick.dbs.orders.db.driver="org.h2.Driver"
slick.dbs.orders.db.url="jdbc:h2:mem:play"

# Customers database
slick.dbs.customers.driver="slick.driver.H2Driver$"
slick.dbs.customers.db.driver="org.h2.Driver"
slick.dbs.customers.db.url="jdbc:h2:mem:play"

Message:

[warn] s.b.DatabaseConfig - Use `profile` instead of `driver`. The latter is deprecated since Slick 3.2 and will be removed.

So the example should be replaced with:

# Orders database
slick.dbs.orders.profile = "slick.jdbc.H2Profile$"
slick.dbs.orders.db.driver="org.h2.Driver"
slick.dbs.orders.db.url="jdbc:h2:mem:play"

# Customers database
slick.dbs.customers.profile = "slick.jdbc.H2Profile$"
slick.dbs.customers.db.driver="org.h2.Driver"
slick.dbs.customers.db.url="jdbc:h2:mem:play"

Make <code> links more visible

When we link to API docs we often put a link around <code> styled text. These links are really hard to see. A normal link is coloured green, but a link around <code> has no additional styling. What I think we should do is apply a slightly different style to code that's within an anchor, e.g.

a code {
  border-color: ...;
  text-color: ...;
  background-color: ...;
}

a:hover code {
  border-color: ...;
  text-color: ...;
  background-color: ...;
}

Erroneous link to documentation on GH

On the bottom of this ScalaAnorm page there's the following text to direct to GH: Found an error in this documentation? The source code for this page can be found here where here links to the non-existent page: https://github.com/playframework/playframework/blob/master/documentation/manual/working/scalaGuide/main/sql/ScalaAnorm.md
This should be linking to: https://github.com/playframework/anorm/blob/master/docs/manual/working/scalaGuide/main/sql/ScalaAnorm.md I'd guess.

Unable to download previous releases from download page

On the download page, the links for previous releases contain the link of the latest release not the respective release. for example href for Play 2.5.0 release is "https://downloads.typesafe.com/typesafe-activator/1.3.9/typesafe-activator-1.3.9-minimal.zip" which is of latest release i.e. Play 2.5.1

Change the Google Search to algolia

Actually the current search of the Playframework Docs isn't really good, it would be great to have the same search experience than akka.io (they use https://www.algolia.com)

Set autofocus on search box

New search box is good, but it could be better. Add in autofocus so people can just start typing:

<input type="text" autofocus>

playframework.com is down

https://playframework.com is down with error message "This webpage has a redirect loop" browser - latest chrome.

modules dependencies always return a dependencies.yml content even if the module doesn't exist

GET         /modules/repo/:name/:version/dependencies.yml            controllers.Modules.dependencies(name, version)

and in modules.scala

In     modulesLookup.findDependencies(name, version) match {
      case Some(yml) => Ok(yml)
      case None => Ok("self: play -> " + name + " " + version)
    }

So we will always have some content even if the module doesn't exist.
ex
https://www.playframework.com/modules/repo/starwars/1.5/dependencies.yml

Update home page with Akka HTTP on 2.6.0

The homepage here needs an update to include "Java NIO via Akka HTTP / Netty" in this part:

Broken contribution link

Steps to reproduce:

• Go to https://www.playframework.com/documentation/2.6.x/ScalaJson
• Navigate to the bottom
• Click on here

Link address is https://github.com/playframework/playframework/edit/2.6.x/documentation/manual/working/scalaGuide/main/json/ScalaJson.md

I am not sure that it relates only to this page. But at least the same behavior is for https://www.playframework.com/documentation/2.6.x/ScalaJsonCombinators

tell users about Gitter room

this came up on scala/scala the other day — a user was asking Play questions, we recommended they use the Play Gitter room and when informed of the existence of https://gitter.im/playframework/playframework, they were surprised because they had looked first on playframework.com and found nothing about it

where should it be added? definitely https://playframework.com/get-involved I would think, under "Find help". perhaps also to the little row of social media icons that show up on every page.

Show latest version of docs in Google results

At the moment, when someone searches Google for Play documentation, they will usually get documentation for some random version of Play. E.g. searching for play framework ws gives results in the following order: 2.2.x Scala, 2.1.0 Scala, 2.4.x Scala, 2.1-RC1 Scala, 2.1.1 Java, 1.1, …

But the latest stable version of Play is 2.3.x, so we what we really want is 2.3.x Scala and 2.3.x Java to be the top results.

We should be able to achieve this by generating a sitemap for playframework.com and using the priority tag to put the latest stable versions at the top of search results.

Add notice for Google searchers

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.

Bad usage of module description "[dotcloud] Dotcloud" in the modules pages

On page https://www.playframework.com/modules, the module " [dotcloud] Dotcloud by Leif Singer" display the full details instead of a simple description.
That make the page look wrong, h1 tag is in a h2 tag.

Links on Download page not working!

The download links for the Play 2.5.x Starter Projects (Play Java Starter Example and Play Scala Starter Example) and the Play 2.5.x Examples (theChatroom, Ebean example an all others) are not working:

no template with the name play-java found

/cc @wsargent @gmethvin

Add blog to playframework.com

This is a placeholder bug for adding blog functionality to playframework.com.

This should be easy enough given that https://github.com/jroper/erqx/ already exists and can be integrated as a subproject into the main playframework.com website.

Also note https://www.lightbend.com/blog/playframework

Download not working anymore!

https://groups.google.com/forum/?fromgroups=#!topic/play-framework/YGvD4Lhdr_w

It's because the zip files are not served via https.

The url's don't contain https when fetched from typesafe:
https://www.typesafe.com/activator/latest

Either we have to convert the urls to https here somewhere or the received json has to be fixed.

%PLAY_VERSION% should be rendered as latest version for *.*.x

For example in https://www.playframework.com/documentation/2.4.x/NewApplication we have:

addSbtPlugin("com.typesafe.play" % "sbt-plugin" % "2.4.x")

which doesn't really make sense. It should just render as the latest version in 2.4.x series.

Japanese characters are corrupted

All Japanese characters are displayed as question marks.

A screenshot of https://www.playframework.com/documentation/ja/2.3.x/Home is below:

Contribution note at the bottom is OK.

Turkish translation also contains similar question marks. But I'm not sure whether it's broken or issue of my font environment.

Tables in doc

Seems styles for table inside page body can be improved for doc generated from markdown on playframework.com (e.g. type table at end of Anorm page).

#content sup {
  font-size: x-small; 
  vertical-align:top }

#content table tr {
  background-color: #fff;
  border-top: 1px solid #ccc
}

#content table th, #content table td {
  border: 1px solid #ddd;
  padding: 6px 13px
}

#content table th { font-weight: bold }

#content table tr:nth-child(2n) { background-color: #f8f8f8 }

"Discuss Play Forum" has a Twitter icon

This probably needs a change like the one we made on the Lagom site, to fix a stylesheet that applies styles based on the link href:

lagom/lagom.github.io@cd5fdfc#diff-21de87fdd137df97b90b1c4fc77599c2L92

activator referenced on homepage

In the "Developer friendly" animation on the https://www.playframework.com/ the activator command is shown:

public/images/home/workflow/terminal.png and [email protected]

Deprecated usages in documentation

PlaySlick documentation contains deprecated configuration for slick:

# Orders database
slick.dbs.orders.driver="slick.driver.H2Driver$"
slick.dbs.orders.db.driver="org.h2.Driver"
slick.dbs.orders.db.url="jdbc:h2:mem:play"

# Customers database
slick.dbs.customers.driver="slick.driver.H2Driver$"
slick.dbs.customers.db.driver="org.h2.Driver"
slick.dbs.customers.db.url="jdbc:h2:mem:play"

Message:

[warn] s.b.DatabaseConfig - Use `profile` instead of `driver`. The latter is deprecated since Slick 3.2 and will be removed.

So the example should be replaced with:

# Orders database
slick.dbs.orders.profile = "slick.jdbc.H2Profile$"
slick.dbs.orders.db.driver="org.h2.Driver"
slick.dbs.orders.db.url="jdbc:h2:mem:play"

# Customers database
slick.dbs.customers.profile = "slick.jdbc.H2Profile$"
slick.dbs.customers.db.driver="org.h2.Driver"
slick.dbs.customers.db.url="jdbc:h2:mem:play"

Sitemaps to prioritise latest docs

At the moment when searching for Play Framework docs the top results are often links to old versions of Play. We should add a sitemap to playframework.com that tells the search engine which version of the docs to prioritise.

There should be a way to switch Play versions on the download page

It'd be nice if we could filter by versions that have the SNAPSHOT branch, for example, and download starter projects for 2.6.x.

Defunct company on homepage

On the https://www.playframework.com/ page under "They already use Play Framework" there's a link to http://zaptravel.com/ but that company doesn't exist anymore.

Use a modal dialog box for documentation warnings

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.

Downloads page has incorrect text

"Note that the seed templates are already configured with CSRF and security headers filters, whereas the other projects are not specifically set up for security out of the box."

Improve documentation for activator test command line parameters

As per documentation activator test works correctly but activator testOnly my.controllers.ControllerClassTest does not work.

It works with activator "test-only my.controllers.ControllerClassTest" and there by needs to be fixed in the playframework.com documentation

OS is Linux:

09:55:47 ~$ uname -rvp
3.19.0-64-generic #72~14.04.1-Ubuntu SMP Fri Jun 24 17:59:48 UTC 2016 x86_64

forms-examples are missing from download section

The https://www.playframework.com/download#examples page is missing the following:

• https://github.com/playframework/play-scala-forms-example
• https://github.com/playframework/play-java-forms-example

Make search input full width

Should change so is not fixed to 600px

https://github.com/playframework/playframework.com/blob/master/app/assets/css/pages/_documentation.styl#L239

Missing pages when coming from old versions

Please see: playframework/playframework#7303

Play 2.6.17 release is missing

https://www.playframework.com/ still shows 2.6.16 as the latest release, but 2.6.17 has already been released: https://blog.playframework.com/play-2-6-17-released/

I will translate a documentation of play framework to korean.

Hello. I'm Lawrence from korea.

I will translate a documentation of play framework to korean.
And I have questions.

1. Where is a english doc?
   => Maybe It is in "https://github.com/playframework/playframework/tree/master/documentation".
   Is it right?
2. How to contact the Play team?
   => I read about deploying in a translation page(https://www.playframework.com/documentation/2.3.x/Translations).
   But I can't how to contact them.
3. And Do I contant the play team after to translate full doc?
   => I'd like to translate point to point. And I think that It will take about three months.
   If it fine some md not translate yet, I hope to deploying my doc in play's web site.

Please, help me. =)
Thanks.

Uncomfortable highlighting style

Cloning the ticket playframework/playframework#7776 in appropriate repository:

I am quiet discouraged about highlighting of key words in manuals.
I think that line spacing should be increased a bit because it is really hard to read.

What do you think?

Link: https://www.playframework.com/documentation/2.6.x/GlobalSettings

Browsers: Chrome, Mozilla

Image path is error in main.min.css created by sbt-stylus plugin on windows platform

I clone the source and start the server on windows 7.
The is something wrong with the image path in main.min.css,which is created by sbt-stylus.

I diff the code with the offical website and found the difference:
On the offical websit, the logo image path is
"https://www.playframework.com/assets/images/logos/play_full_color.svg"
but,On my local server, the logo image path is
"http://localhost:9000/assets/css/\assets\images\logos\play_full_color.svg"
Bellow is the screenshot.
I'm not good at stylus, is there any help?

Fix documentation for Play1 maven module

In play1 we have an issue for a module documentation Play1 issue #1299
In the maven module page

We should replace

play mvn:source // or play mvn:src

by

play mvn:sources // or play mvn:src

Play package in chocolate is out of date

Hi, play framework package in chocolate is still 2.3.6 version. Could you upgrade it? Thanks!

Alternative downloads section is confusing

All the newer play versions point to activator on the download page. I don't think that makes sense, as the links don't correspond to the Play versions at all, and it's really unclear how you would use activator to create a project with that specific play version.

Fix formatting on RabbitMQ module's page

Link: Rabbit module

Anorm

The Anorm page in the Play 2.5 docs is mentioning an older Anorm version (2.4) and re-use the document from Anorm 2.4, instead of indicating elements about Anorm 2.5.

This kind of update issue is related to the one filed on the Anorm repo, as Anorm doc is not yet regularly published as a standalone project.