Improvements for the "try-play" page #206

marcospereira · 2018-04-09T22:50:39Z

This is a follow up of #192 by @rstento. There are some changes here that depend on documentation improvements too, so another pull request will be made to improve Play docs and make it consistent
with the changes here.

@rstento, @richdougherty, @gmethvin, and @wsargent, please review.

marcospereira · 2018-04-09T22:53:08Z

app/views/gettingStarted.scala.html

+
+@renderProject(project: ExampleProject) = {
+    <tr>
+        <td><a href="@project.downloadUrl" target="_blank">@project.displayName</a></td>


@rstento we get data for sample projects using Tech Hub API. The only URLs available there are for download and Github. To avoid hardcoding the links, I've decided to keep the current way of listing the starter projects.

I think that's OK for now, but we can do some usability improvements later. It will help when Tech Hub allows us to filter for Java and Scala as mentioned in my review of the doc changes.

marcospereira · 2018-04-09T22:53:48Z

app/views/gettingStarted.scala.html

+                    <h3><span>&raquo;</span> Learn whether Play Framework is right for your project</h3>
+                    <div class="try-option-content">
+                        <ul>
+                            <li><a href="@controllers.documentation.ReverseRouter.latest(None, "Introduction")">Introduction to Play</a></li>


Introduction and Requirements are two new pages at the docs.

richdougherty

A few minor changes.

richdougherty · 2018-04-18T02:35:04Z

app/views/gettingStarted.scala.html

+                    <div class="try-option-content">
+                        <ul>
+                            <li><a href="@controllers.documentation.ReverseRouter.latest(None, "Introduction")">Introduction to Play</a></li>
+                            <li><a href="@controllers.documentation.ReverseRouter.latest(None, "Requirements")">Requirements to work With Play</a></li>


Either System Requirements or Requirements for using Play read better to me. 😄

richdougherty · 2018-04-18T02:36:06Z

app/views/gettingStarted.scala.html

+                <div class="try-option">
+                    <h3><span>&raquo;</span> Follow the Hello World Tutorial</h3>
+                    <div class="try-option-content">
+                        <p>Play requires Java SE 1.8 or higher. You can check your version with the <code>java -version</code> command or install it from <a href="//www.oracle.com/technetwork/java/javase/downloads/index.html" rel="noopener">Oracle's site</a>. See details about the <a href="@controllers.documentation.ReverseRouter.latest(None, "Requirements")">requirements to work with Play</a>.</p>


Related to the previous change: See details about the requirements to work with Play → See details about Play's system requirements

richdougherty · 2018-04-18T02:41:32Z

app/views/gettingStarted.scala.html

+                <div class="try-option">
+                    <h3><span>&raquo;</span> Follow the Hello World Tutorial</h3>
+                    <div class="try-option-content">
+                        <p>Play requires Java SE 1.8 or higher. You can check your version with the <code>java -version</code> command or install it from <a href="//www.oracle.com/technetwork/java/javase/downloads/index.html" rel="noopener">Oracle's site</a>. See details about the <a href="@controllers.documentation.ReverseRouter.latest(None, "Requirements")">requirements to work with Play</a>.</p>


Do you think it would be easier for beginners to understand if we call it Java 8 rather than Java 1.8?

richdougherty · 2018-04-18T02:41:52Z

app/views/gettingStarted.scala.html

+            <div class="try-section">
+                <h2>Already know a bit about Play?</h2>
+                <p>Check out our <a href="//developer.lightbend.com/start/?group=play">example projects for Java or Scala</a>. The downloadable zip files include everything you need, including <a href="//www.scala-sbt.org/index.html">sbt</a>, Play Framework, and an HTTP server. Examples also support <a href="//docs.gradle.org/current/userguide/play_plugin.html">Gradle</a>. You can also create a Play project from the command line using a template if you have sbt installed already.</p>
+                <p>Play requires Java SE 1.8 or higher. You can check your version with the <code>java -version</code> command or install it from <a href="//www.oracle.com/technetwork/java/javase/downloads/index.html" rel="noopener">Oracle's site</a>. See details about the <a href="@controllers.documentation.ReverseRouter.latest(None, "Requirements")">requirements to work with Play</a>.</p>


Same comment about Java 8 vs 1.8 and text for system requirements.

richdougherty · 2018-04-18T02:42:13Z

app/views/gettingStarted.scala.html

+                    <div class="try-option-content">
+                        <p>Follow these steps to try an example project:</p>
+                        <ol>
+                            <li>Choose an example from <a href="">Lightbend's Tech Hub</a>.</li>


Still needs href value.

richdougherty · 2018-04-18T02:46:03Z

app/views/gettingStarted.scala.html

+                        <p>Follow these steps to try an example project:</p>
+                        <ol>
+                            <li>Choose an example from <a href="">Lightbend's Tech Hub</a>.</li>
+                            <li>Click "CREATE A PROJECT FOR ME" to download the zipped project.</li>


Use text-transform: uppercase? (Very minor!)

richdougherty · 2018-04-18T02:46:47Z

app/views/gettingStarted.scala.html

+                            <li>In a command window, navigate to the top level project directory.</li>
+                            <li>Enter one of the following commands:
+                                <ul>
+                                    <li>On OSx or Linux systems: <code>./sbt run</code> or <code>./gradlew runPlayBinary</code></li>


OSx → macOS

gmethvin · 2018-04-29T01:57:47Z

app/views/gettingStarted.scala.html

+                    <div class="try-option-content">
+                        <p>Follow these steps to try an example project:</p>
+                        <ol>
+                            <li>Choose an example from <a href="https://developer.lightbend.com/start/?group=play">Lightbend's Tech Hub</a>.</li>


What's the advantage of moving these examples off the download page and onto another site? I think it makes the experience less streamlined.

Increase awareness of Tech Hub. But I agree that it is less streamlined.

But I think we can have both. We can have a streamlined experience here, at the "try play" page, and have other places linking to Tech Hub (and even this page too).

@rstento, what do you think?

Can we go ahead with these changes and see what they look like? I always find it helps when you see it live. Then maybe we can revisit?

@rstento 👍

rstento · 2018-05-14T16:23:54Z

app/views/gettingStarted.scala.html

+
+@renderProject(project: ExampleProject) = {
+    <tr>
+        <td><a href="@project.downloadUrl" target="_blank">@project.displayName</a></td>


I think that's OK for now, but we can do some usability improvements later. It will help when Tech Hub allows us to filter for Java and Scala as mentioned in my review of the doc changes.

rstento · 2018-05-14T16:25:49Z

app/views/gettingStarted.scala.html

+                    <div class="try-option-content">
+                        <p>Follow these steps to try an example project:</p>
+                        <ol>
+                            <li>Choose an example from <a href="https://developer.lightbend.com/start/?group=play">Lightbend's Tech Hub</a>.</li>


Can we go ahead with these changes and see what they look like? I always find it helps when you see it live. Then maybe we can revisit?

@rstento

This is a follow up of #192 by @rstento. There are some changes here that depends on documentation improvements too, so another pull request will be made to improve Play docs and make it consistent with the changes here.

ignasi35

The changes LGTM I guess. Few details go over my head TBH.

marcospereira commented Apr 9, 2018

View reviewed changes

richdougherty suggested changes Apr 18, 2018

View reviewed changes

marcospereira mentioned this pull request Apr 27, 2018

Getting starter experience improvements playframework/playframework#8385

Merged

gmethvin reviewed Apr 29, 2018

View reviewed changes

rstento approved these changes May 14, 2018

View reviewed changes

richdougherty approved these changes May 31, 2018

View reviewed changes

marcospereira added 3 commits June 24, 2018 22:15

Improvements for the "try-play" page

6a1e380

This is a follow up of #192 by @rstento. There are some changes here that depends on documentation improvements too, so another pull request will be made to improve Play docs and make it consistent with the changes here.

Minor fixes after review

7aa3ea1

Configure redirect from Installing to Requirements

60090dd

ignasi35 approved these changes Sep 21, 2018

View reviewed changes

marcospereira merged commit 65a7be9 into playframework:master Sep 21, 2018

marcospereira deleted the getting-starter-experience-improvements branch September 21, 2018 14:06

marcospereira mentioned this pull request Sep 21, 2018

Revert "First set of changes to remove "download" terminology (#192)" #228

Closed

Uh oh!

Improvements for the "try-play" page #206

Improvements for the "try-play" page #206

Uh oh!

Conversation

marcospereira commented Apr 9, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

richdougherty left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ignasi35 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants