Skip to content

Commit f5f99d4

Browse files
committed
Updates to getting started documentation.
1 parent 494e3d4 commit f5f99d4

3 files changed

Lines changed: 46 additions & 108 deletions

File tree

app/controllers/Application.scala

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -81,20 +81,9 @@ class Application @Inject()(
8181
MovedPermanently(routes.Application.gettingStarted.path)
8282
}
8383

84-
def gettingStarted = Action.async { implicit request =>
85-
exampleProjectsService.cached() match {
86-
case Some(cached) =>
87-
val examples = toExamples(cached)
88-
Future.successful {
89-
Ok(html.gettingStarted(examples))
90-
}
91-
case None =>
92-
exampleProjectsService.examples().map { live =>
93-
val examples = toExamples(live)
94-
Ok(html.gettingStarted(examples))
95-
}
96-
}
97-
}
84+
def gettingStarted = markdownAction("public/markdown/getting-started.md", { implicit request => markdown =>
85+
views.html.markdownPage("Community process", markdown)
86+
})
9887

9988
def allreleases(platform: Option[String] = None) = Action { implicit request =>
10089
val selectedPlatform = Platform(platform.orElse(request.headers.get("User-Agent")))

app/views/gettingStarted.scala.html

Lines changed: 0 additions & 94 deletions
This file was deleted.

public/markdown/getting-started.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Getting started with Play framework
2+
3+
## Learn whether Play Framework is right for your project
4+
5+
- [What is play?](documentation/2.8.x/Introduction)
6+
7+
## First time Play user?
8+
9+
Check out the [getting started guide](documentation/2.8.x/Home) to install system dependencies and run a minimal
10+
play application! This is the best place to start if you are new to Scala, Java or Play.
11+
12+
## Already know a bit about Play?
13+
14+
[In the play-samples repository](https://github.com/playframework/play-samples) there are a variety of example
15+
projects in both Java and Scala for a particular use case. These include everything you need, including sbt, Play
16+
Framework and 3rd part dependencies.
17+
18+
If you have all [system requirements](documentation/2.8.x/Home) installed, and you are ready to start your own project
19+
you can create a Play project from the command line. Go to you projects folder and run one of the following commands:
20+
21+
### Java seed template
22+
23+
```bash
24+
sbt new playframework/play-java-seed.g8
25+
```
26+
27+
## Scala seed template
28+
29+
```bash
30+
sbt new playframework/play-scala-seed.g8
31+
```
32+
33+
For more information on setting up the seed project, [Check out the documentation](documentation/2.8.x/Home).
34+
35+
## Community
36+
37+
[Check out our forum, Discord and Open Collective!](get-involved)
38+
39+
## Contribute
40+
41+
Play is a community run project, and we are always happy to have people contribute Play is hosted on
42+
[Github](https://github.com/playframework). If you have found an issue with Play or a problem with the documentation
43+
please report that [on the github issue tracker](https://github.com/playframework/playframework/issues).

0 commit comments

Comments
 (0)