Skip to content

WIP change Try play page example from starter project to tutorials - #231

Merged
dwijnand merged 3 commits into
playframework:masterfrom
rstento:try-play-page-improvements
Nov 27, 2018
Merged

WIP change Try play page example from starter project to tutorials#231
dwijnand merged 3 commits into
playframework:masterfrom
rstento:try-play-page-improvements

Conversation

@rstento

@rstento rstento commented Nov 2, 2018

Copy link
Copy Markdown
Contributor

@dwijnand, @ignasi35, The objective of this is to change the recommended example (Follow the Hello World Tutorial) on the https://www.playframework.com/getting-started page to point to the correct Hello World Tutorial examples. In addition, I made some edits to simplify and clarify the page.

The changes I made look good when I build the web pages except, they do not display the links to download the Hello World Tutorials from Tech Hub:

image

No links appear here.

Maybe it needs to be live to pull in the links from the example-code-service? If not, could you take a look at the Application controller, I might have made a mistake while switching out the starters examples for tutorials. For your reference, on Tech Hub, the play-templates.conf file defines them like this:

tutorials = [
    {
      display-name = "Play Scala Hello World Tutorial"
      name = "play-scala-hello-world-tutorial"
      url = "git@github.com:playframework/play-scala-hello-world-tutorial.git"
      github-repo = "playframework/play-scala-hello-world-tutorial"
      branch = "2.6.x"
      keywords = [ "play", "scala", "tutorial", "hello-world", "2.6.x" ]
      "featured": {
        "play": 0
      },
      summary = "Play Hello World tutorial in Scala"
      description = "This tutorial introduces Play Framework, describes how Play web applications work, and walks you through steps to create page that displays a Hello World greeting."
    },
    {
      display-name = "Play Java Hello World Tutorial"
      name = "play-java-hello-world-tutorial"
      url = "git@github.com:playframework/play-java-hello-world-tutorial.git"
      github-repo = "playframework/play-java-hello-world-tutorial"
      branch = "2.6.x"
      keywords = [ "play", "java", "tutorial", "hello-world", "2.6.x" ]
      summary = "Play Hello World tutorial in Java"
      description = "This tutorial introduces Play Framework, describes how Play web applications work, and walks you through steps to create page that displays a Hello World greeting."
    }
  ]

<li><a href="@controllers.documentation.ReverseRouter.latest(None, "Philosophy")">Our philosophy</a></li>
<li><a href="@controllers.documentation.ReverseRouter.latest(None, "Introduction")" target="_blank">Introduction to Play</a></li>
<li><a href="@controllers.documentation.ReverseRouter.latest(None, "Philosophy")" target="_blank">Our philosophy</a></li>
<li><a href="@controllers.documentation.ReverseRouter.latest(None, "Requirements")" target="_blank">Requirements for using Play</a></li>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why target="_blank"?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @dwijnand, Because if the reader wants to go read about Play and come back and try the examples, this way the page will still be open in their original tab. I've been doing a lot of documentation research lately and this is a common best practice when the link is supplemental information but the reader likely wants to come back and continue with the page.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, interesting :)

@dwijnand
dwijnand merged commit 11a37fd into playframework:master Nov 27, 2018

@dwijnand dwijnand left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @rstento. I think I spotted the mistake and I also had a question. But nothing impeeding this from being accepted! Thank you!

@ignasi35

Copy link
Copy Markdown
Member

This went completely under my radar. Nice change @rstento

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants