Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Update getting started pages. #478

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 3 additions & 14 deletions app/controllers/Application.scala
Original file line number Diff line number Diff line change
Expand Up @@ -81,20 +81,9 @@ class Application @Inject()(
MovedPermanently(routes.Application.gettingStarted.path)
}

def gettingStarted = Action.async { implicit request =>
exampleProjectsService.cached() match {
case Some(cached) =>
val examples = toExamples(cached)
Future.successful {
Ok(html.gettingStarted(examples))
}
case None =>
exampleProjectsService.examples().map { live =>
val examples = toExamples(live)
Ok(html.gettingStarted(examples))
}
}
}
def gettingStarted = markdownAction("public/markdown/getting-started.md", { implicit request => markdown =>
views.html.markdownPage("Getting started", markdown)
})

def allreleases(platform: Option[String] = None) = Action { implicit request =>
val selectedPlatform = Platform(platform.orElse(request.headers.get("User-Agent")))
Expand Down
94 changes: 0 additions & 94 deletions app/views/gettingStarted.scala.html

This file was deleted.

44 changes: 44 additions & 0 deletions public/markdown/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Getting started with Play framework

## Learn whether Play Framework is right for your project

- [What is play?](documentation/2.8.x/Introduction)

## First time Play user?

Check out the [getting started guide](documentation/2.8.x/Home) to install system dependencies and run a minimal
play application! This is the best place to start if you are new to Scala, Java or Play.

## Already know a bit about Play?

[In the play-samples repository](https://github.com/playframework/play-samples) there are a variety of example
projects in both Java and Scala for a particular use case. These include everything you need, including sbt, Play
Framework and 3rd part dependencies.

If you have all [system requirements](documentation/2.8.x/Home) installed, and you are ready to start your own project
you can create a Play project from the command line. Go to you projects folder and run one of the following commands:

### Java seed template

```bash
sbt new playframework/play-java-seed.g8
```

## Scala seed template

```bash
sbt new playframework/play-scala-seed.g8
```

For more information on setting up the seed project, [Check out the documentation](documentation/2.8.x/Home).

## Community

[Check out our forum, Discord and Open Collective!](get-involved)

## Contribute

Play is a community run project, and we are always happy to have people contribute to the project! Play is hosted on
[Github](https://github.com/playframework), so, issues with Play or a problems with the documentation
can be reported [on the github issue tracker](https://github.com/playframework/playframework/issues).