Permalink
Browse files

First documentation review – Reorganize, fix broken links

  • Loading branch information...
1 parent a554da9 commit 226ca78f71f397f1d41af56a0fae72c9828a23aa @guillaumebort guillaumebort committed Oct 31, 2012
Showing with 509 additions and 1,316 deletions.
  1. +0 −24 documentation/manual/2.1-roadmap.md
  2. +0 −76 documentation/manual/Deploying-on-CloudFoundry.md
  3. +0 −49 documentation/manual/Deploying-to-AppFog.md
  4. +0 −46 documentation/manual/Deploying-to-dotCloud.md
  5. +0 −11 documentation/manual/Documentation.md
  6. +0 −3 documentation/manual/H2-database-tips.md
  7. +15 −36 documentation/manual/Home.md
  8. +0 −1 documentation/manual/JavaOAuth.md
  9. +0 −34 documentation/manual/Managing-Controller-Class-Instantiation.md
  10. +0 −1 documentation/manual/Mine.md
  11. +0 −112 documentation/manual/Play-2.0-for-Play-1.x-developers.md
  12. +0 −1 documentation/manual/Productiondist.md
  13. +0 −30 documentation/manual/ScalaDependencyInjection.md
  14. +0 −54 documentation/manual/Writing-Modules.md
  15. +7 −16 documentation/manual/_Sidebar.md
  16. +0 −3 documentation/manual/detailledTopics/assets/Assets.md
  17. +2 −2 documentation/manual/detailledTopics/assets/AssetsCoffeeScript.md
  18. +0 −4 documentation/manual/detailledTopics/assets/AssetsGoogleClosureCompiler.md
  19. +2 −2 documentation/manual/detailledTopics/assets/AssetsLess.md
  20. +12 −8 documentation/manual/{ → detailledTopics/assets}/RequireJS-support.md
  21. +7 −7 documentation/manual/detailledTopics/assets/_Sidebar.md
  22. +8 −4 documentation/manual/detailledTopics/build/Build.md
  23. +1 −5 documentation/manual/detailledTopics/build/SBTDependencies.md
  24. +2 −2 documentation/manual/detailledTopics/build/SBTSettings.md
  25. +7 −9 documentation/manual/detailledTopics/build/SBTSubProjects.md
  26. +6 −7 documentation/manual/detailledTopics/build/_Sidebar.md
  27. +1 −1 documentation/manual/detailledTopics/configuration/SettingsJDBC.md
  28. +6 −7 documentation/manual/detailledTopics/configuration/_Sidebar.md
  29. +13 −8 documentation/manual/{ → detailledTopics/database}/Developing-with-the-H2-Database.md
  30. +2 −6 documentation/manual/detailledTopics/evolutions/Evolutions.md
  31. +11 −8 documentation/manual/{ → detailledTopics/production}/Deploying-CloudFoundry.md
  32. +2 −0 documentation/manual/{ → detailledTopics/production}/Deploying-to-CloudBees.md
  33. +1 −1 documentation/manual/detailledTopics/production/Production.md
  34. +23 −0 documentation/manual/detailledTopics/production/ProductionDist.md
  35. +9 −10 documentation/manual/detailledTopics/production/_Sidebar.md
  36. +4 −4 documentation/manual/gettingStarted/Anatomy.md
  37. +33 −33 documentation/manual/gettingStarted/IDE.md
  38. +3 −3 documentation/manual/gettingStarted/Installing.md
  39. +6 −6 documentation/manual/gettingStarted/NewApplication.md
  40. +3 −3 documentation/manual/gettingStarted/PlayConsole.md
  41. +5 −5 documentation/manual/gettingStarted/Samples.md
  42. +3 −3 documentation/manual/hacking/BuildingFromSource.md
  43. +69 −31 documentation/manual/hacking/Guidelines.md
  44. +0 −19 documentation/manual/hacking/PullRequests.md
  45. +2 −3 documentation/manual/hacking/_Sidebar.md
  46. +4 −9 documentation/manual/javaGuide/JavaHome.md
  47. +1 −1 documentation/manual/javaGuide/_Sidebar.md
  48. +0 −76 documentation/manual/javaGuide/advanced/routing/JavaJavascriptRouting.md
  49. +2 −1 documentation/manual/javaGuide/main/async/_Sidebar.md
  50. +2 −1 documentation/manual/javaGuide/main/forms/_Sidebar.md
  51. +2 −1 documentation/manual/javaGuide/main/global/_Sidebar.md
  52. +1 −8 documentation/manual/javaGuide/main/http/JavaSessionFlash.md
  53. +2 −1 documentation/manual/javaGuide/main/http/_Sidebar.md
  54. +2 −1 documentation/manual/javaGuide/main/sql/_Sidebar.md
  55. +2 −1 documentation/manual/javaGuide/main/templates/_Sidebar.md
  56. +2 −1 documentation/manual/javaGuide/main/tests/_Sidebar.md
  57. +2 −1 documentation/manual/javaGuide/main/ws/_Sidebar.md
  58. +1 −1 documentation/manual/javaGuide/tutorials/todolist/JavaTodoList.md
  59. +47 −115 documentation/manual/javaGuide/tutorials/zentasks/JavaGuide1.md
  60. +30 −87 documentation/manual/javaGuide/tutorials/zentasks/JavaGuide2.md
  61. +24 −70 documentation/manual/javaGuide/tutorials/zentasks/JavaGuide3.md
  62. +31 −86 documentation/manual/javaGuide/tutorials/zentasks/JavaGuide4.md
  63. +14 −40 documentation/manual/javaGuide/tutorials/zentasks/JavaGuide5.md
  64. +28 −99 documentation/manual/javaGuide/tutorials/zentasks/JavaGuide6.md
  65. +28 −0 documentation/manual/javaGuide/tutorials/zentasks/_Sidebar.md
  66. +2 −2 documentation/manual/scalaGuide/ScalaHome.md
  67. +14 −14 documentation/manual/scalaGuide/main/async/ScalaAsync.md
  68. +0 −1 documentation/manual/scalaGuide/main/json/_Sidebar.md
  69. +3 −1 documentation/manual/{Scalatemplates.md → scalaGuide/main/templates/ScalaTemplates.md}
@@ -1,24 +0,0 @@
-_please do not edit this page unless you are a team member_
-
-here is the full list:
-https://play.lighthouseapp.com/projects/82401-play-20/milestones/current
-
-a few highlights:
-
-* Move to Scala 2.10 and sbt 0.12.
-* Replace the current Play Promise Scala API by the standard Scala
-Promise API (SIP-14).
-* Introduce "Project templates" hosted on git (a la giter8) and "Scaffolding".
-* Run tests in a forked JVM (to fully suppress PermGen memory leaks).
-* Simplified configuration for thread pools (we have decided to use a
-single akka system for the whole play environment).
-* Scala JSON API improvement (with support for functional validation).
-* Java Async API improvement (HTTP context propagation in asynchronous
-callback, and sequential execution to avoid race conditions).
-* Improve modularization (break the main play artifact into several
-smaller optional ones).
-* Compilation speed improvements (thanks to the new Scala 2.10
-compiler, the sbt 0.12 experimental resident compiler and router changes).
-* Upgrade all dependencies
-* improve asset dependency resolution/require support (that is, it should work transparently both at client and server side) [[ticket](https://play.lighthouseapp.com/projects/82401-play-20/tickets/610)]
-* SSL support
@@ -1,76 +0,0 @@
-# Deploying to Cloudfoundry (Preview)
-[Cloud Foundry](http://cloudfoundry.com/) is a cloud application platform - Deploy and scale applications in seconds, without locking yourself into a single cloud.
-
-## Prerequisite
-Before you can deploy your app in cloudfoundry.com, you need to **open an account** with cloudfoundry.com. After registering it takes a day or two to get your account activated.
-
-You also have to have either the vmc command line tool or STS (eclipse plugin) installed on your system - visit the [getting started](http://docs.cloudfoundry.com/getting-started.html) link and follow the instructions there.
-
-Once you have set-up the pre-requisites and got your user name and password from cloudfoundry.com - you are all set to deploy your app on cloudfoundry.com Paas.
-
-## Deploying
-Next we will bundle the application : `play dist`
-
-We want to push the application contents as folder structure and not as zip so that we want to be able to push deltas later on. Hence open the folder myPlayApp/dist in your explorer and extract the contents inside 'myPlayApp-1.0-SNAPSHOT.zip' in the same folder.
-
-Delete the myPlayApp-1.0-SNAPSHOT.zip. Go inside the myPlayApp-1.0-SNAPSHOT folder and delete the README and start files as well - we do not need them.
-
-Now we are ready to push our content to cloudfoundry. Let's login to cloudfoundry first.
-
-```bash
-$ cd dist/myPlayApp-1.0-SNAPSHOT/
-$ vmc login
-```
-
-> Attempting login to [http://api.cloudfoundry.com] <br />
-> Email: ratul75@hotmail.com <br />
-> Password: ****************** <br />
-> Successfully logged into [http://api.cloudfoundry.com]<br />
-
-```bash
-$ vmc target api.cloudfoundry.com
-```
-
-> Successfully targeted to [http://api.cloudfoundry.com]
-
-When prompted by vmc, answer with y or n as shown below.
-
-```bash
-$ vmc push
-```
-
-> Would you like to deploy from the current directory? [Yn]: **y**<br />
-> Application Name: **myPlayApp**<br />
-> Detected a Standalone Application, is this correct? [Yn]: **y**<br />
-> 1: java<br />
-> 2: node<br />
-> 3: node06<br />
-> 4: ruby18<br />
-> 5: ruby19<br />
-> Select Runtime [java]: **1**<br />
-> Selected java<br />
-> Start Command: **java $JAVA_OPTS -Dhttp.port=$VCAP_APP_PORT -cp "\`dirname \`/lib/*" play.core.server.NettyServer \`dirname \`**<br />
-> Application Deployed URL [None]: **myPlayApp.${target-base}** <br />
-> Memory reservation (128M, 256M, 512M, 1G, 2G) [512M]: **256M**<br />
-> How many instances? [1]: **1**<br />
-> Create services to bind to 'myPlayApp'? [yN]: **n**<br />
-> Would you like to save this configuration? [yN]: **y**<br />
-> Manifest written to manifest.yml.<br />
-> Creating Application: OK<br />
-> Uploading Application:<br />
-> Checking for available resources: OK<br />
-> Processing resources: OK<br />
-> Packing application: OK<br />
-> Uploading (80K): OK <br />
-> Push Status: OK<br />
-> Staging Application 'myPlayApp': OK<br />
-> Starting Application 'myPlayApp': OK<br />
-
-
-## Extract data from cloudfoundry
-In your application you can fetch datas from cloudfoundry through the environment variables :
-
-```java
-System.getenv("VCAP_APP_PORT")
-System.getenv("VCAP_APP_HOST")
-```
@@ -1,49 +0,0 @@
-AppFog is based off the the Cloud Foundry open source project. The [Cloud Foundry deployment instructions](https://github.com/playframework/Play20/wiki/Deploying-CloudFoundry) are more detailed and will work with AppFog as well. Just replace "vmc" with "af".
-
-## Prerequisites
-
-1. Sign up for a free [AppFog](http://appfog.com/) account
-
-2. Install the AppFog command line tool (version 0.3.18 or higher required) by using the following command:
-
-```bash
-gem install af
-```
-
-2. Login to AppFog on the console:
-
-```bash
-af login
-```
-
-## Build your Application
-Package your app by typing the 'dist' command in the play prompt.
-
-## Deploy your Application
-Deploy the created zip file to AppFog with the af push command.
-
-```bash
-yourapp$ af push --path=dist/yourapp-1.0.zip
-Application Name: yourapp
-Detected a Play Framework Application, is this correct? [Yn]:
-1: AWS US East - Virginia
-2: AWS EU West - Ireland
-3: AWS Asia SE - Singapore
-4: Rackspace AZ 1 - Dallas
-5: HP AZ 2 - Las Vegas
-Select Infrastructure: 5
-Application Deployed URL [yourapp.hp.af.cm]:
-Memory reservation (128M, 256M, 512M, 1G, 2G) [256M]:
-How many instances? [1]:
-Create services to bind to 'yourapp'? [yN]:
-Would you like to save this configuration? [yN]:
-Creating Application: OK
-Uploading Application:
- Checking for available resources: OK
- Processing resources: OK
- Packing application: OK
- Uploading (5M): OK
-Push Status: OK
-Staging Application 'yourapp': OK
-Starting Application 'yourapp': OK
-```
@@ -1,46 +0,0 @@
-# Deploying to dotCloud
-
-[[dotCoud | http://www.dotcloud.com/]] is a very flexible cloud application platform.
-
-## Clone play2-on-dotcloud project
-
-```bash
-$ git clone git://github.com/mchv/play2-on-dotcloud.git
-```
-
-When the clone is finished you could delete the _.git_ directory.
-
-## Copy your application code
-
-Copy your application code in the _application_ folder.
-
-## Create a new application on dotCloud
-
-> Note that you need an dotCloud account, and to [[install dotCloud client | http://docs.dotcloud.com/firststeps/install/]].
-
-```bash
-$ dotcloud create myplay2app
-Created application "myplay2app"
-```
-
-## Deploy your application
-
-The dotCloud client check if you use git or mercurial, and if so will deploy by default only [[committed changes | http://docs.dotcloud.com/guides/git-hg/]]. Otherwise it will simply upload only the diff with the previous deployment using rsync.
-
-```bash
-$ dotcloud push myplay2app
-```
-
-If you want to commit all files and not only the diff or last committed changes use:
-
-```bash
-$ dotcloud push myplay2app --all
-```
-
-## Checking logs
-
-If something goes weird, you could check the logs to see what's happening.
-
-```bash
-$ dotcloud logs myplay2app.play
-```
@@ -1,11 +0,0 @@
-# Documentation
-
-Play comes with documentation built into the framework, so even if you are not online you can access documentation and the API locally.
-
-To access the local documentation, start your application by typing
-
-```
-play run
-```
-
-Then go to the special URL /@documentation -- if your server was started on port 9000, this would be [http://localhost:9000/@documentation](http://localhost:9000/@documentation).
@@ -1,3 +0,0 @@
-Moved see: [Developing with the h2 database](https://github.com/playframework/Play20/wiki/Developing-with-the-H2-Database)
-
-Please delete this page on 1 Sept 2012. This link was published in the mailing list.
@@ -1,27 +1,23 @@
-# Play 2.0 documentation
+# Play 2.1 documentation
-> Play 2.0 is a high-productivity Java and Scala web application framework that integrates the components and APIs you need for modern web application development.
+> Play is a high-productivity Java and Scala web application framework that integrates the components and APIs you need for modern web application development.
>
> Play is based on a lightweight, stateless, web-friendly architecture and features predictable and minimal resource consumption (CPU, memory, threads) for highly-scalable applications thanks to its reactive model, based on Iteratee IO.
-## About
-
-1. [[Play 2.0 a Web framework for a new era | Philosophy]]
-
## Getting started
-1. [[Installing Play 2.0 | Installing]]
+1. [[Installing Play | Installing]]
1. [[Creating a new application | NewApplication]]
-1. [[Anatomy of a Play 2.0 application | Anatomy]]
-1. [[Using the Play 2.0 console | PlayConsole ]]
+1. [[Anatomy of a Play application | Anatomy]]
+1. [[Using the Play console | PlayConsole ]]
1. [[Setting up your preferred IDE | IDE]]
-1. [[Built-in documentation | Documentation ]]
1. [[Sample applications | Samples]]
+1. [[Security policy | http://www.playframework.org/code/security]]
-## Working with Play 2.0
+## Working with Play
-1. [[Play 2.0 for Scala developers | ScalaHome]]
-1. [[Play 2.0 for Java developers | JavaHome]]
+1. [[Play for Scala developers | ScalaHome]]
+1. [[Play for Java developers | JavaHome]]
## Detailed topics
@@ -34,17 +30,19 @@
1. [[Using LESS CSS | AssetsLess]]
1. [[Using Google Closure Compiler | AssetsGoogleClosureCompiler]]
1. [[Using RequireJS | RequireJS-support]]
+1. [[Working with the in-memory H2 database | Developing-with-the-H2-Database]]
1. [[Managing database evolutions | Evolutions]]
1. [[Configuration file syntax and features | Configuration]]
1. [[Configuring the JDBC connection pool | SettingsJDBC]]
1. [[Configuring the internal Akka system | AkkaCore]]
1. [[Configuring logging | SettingsLogger]]
1. [[Deploying your application | Production]]
+ 1. [[Creating a standalone package | ProductionDist]]
1. [[Additional configuration | ProductionConfiguration]]
+ 1. [[Set-up a front-end HTTP server | HTTPServer]]
1. [[Deploying to Heroku | ProductionHeroku]]
- 1. [[Deploying to Cloud Foundry | Deploying-CloudFoundry]]
1. [[Deploying to CloudBees | Deploying-to-CloudBees]]
- 1. [[Set-up a front-end HTTP server | HTTPServer]]
+ 1. [[Deploying to Cloud Foundry | Deploying-CloudFoundry]]
## Additional documentation
@@ -54,34 +52,15 @@
1. [[Configuration|https://github.com/typesafehub/config]]
1. [[Logback|http://logback.qos.ch/documentation.html]]
-## Hacking Play 2.0
+## Hacking Play
-1. [[Building Play 2.0 from source | BuildingFromSource]]
+1. [[Building Play from source | BuildingFromSource]]
1. [[CI server at Cloudbees | CIServer]]
1. [[Repositories | Repositories]]
1. [[Issue tracker | Issues]]
-1. [[Pull requests | PullRequests]]
1. [[Contributor guidelines | Guidelines]]
## Modules and plugins
1. [[Temporary modules directory | Modules]]
-## Security policy
-1. [[play's security policy |http://www.playframework.org/code/security]]
-
-## User groups
-1. [[User groups around the world | User-Groups-around-the-World]]
-
-## Contributing to this documentation
-
-> The documentation is freely editable on [[https://github.com/playframework/Play20/wiki]]. Feel free to fix mistakes directly in the pages.
->
-> However if you want to provide additional documentation, please create new pages and reference them from here. A member of the core team will take care of integrating it in the most appropriate section.
-
-
-###Needs to be integrated
-* [[Play 2.0 for Play 1.x developers |Play-2.0-for-Play-1.x-developers]]
-* [[Howto write modules | Writing-Modules ]]
-* [[IDE | IDE]]
-* [[3.1 Developing with the H2 Database | Developing-with-the-H2-Database]]
@@ -1 +0,0 @@
-play.libs.OAuth
@@ -1,34 +0,0 @@
-> Available in Play 2.1
-
-By default Play binds URLs to controller methods _statically_, that is, Controller instances are created by the framework and then the appropriate static method is invoked depending on the given URL. In certain situations, however, you may want to manage controller creation and that's when the new routing syntax comes handy.
-
-Route definitions starting with ```@``` will be managed by ```play.GlobalSettings#getControllerInstance``` method, so given the following route definition:
-
- GET / @controllers.Application.index()
-
-Play will invoke ```play.GlobalSettings#getControllerInstance``` which in return will provide an instance of ```controllers.Application``` (by default this is happening via ```controllers.Application```'s default constructor). Therefore, if you want to manage controller class instantiation either via a dependency injection framework or manually you can do so by overriding ```getControllerInstance``` in your application's ```Global``` class.
-
-Here's an example using Guice:
-```java
- import play.GlobalSettings;
-
- import com.google.inject.Guice;
- import com.google.inject.Injector;
-
- public class Global extends GlobalSettings {
-
- private static final Injector INJECTOR = createInjector();
-
- @Override
- public <A> A getControllerInstance(Class<A> controllerClass) throws Exception {
- return INJECTOR.getInstance(controllerClass);
- }
-
- private static Injector createInjector() {
- return Guice.createInjector();
- }
-
- }
-```
-another example using Spring:
-https://github.com/guillaumebort/play20-spring-demo
@@ -1 +0,0 @@
-Hello, how are you
Oops, something went wrong.

0 comments on commit 226ca78

Please sign in to comment.