From b1f28022e1d9f35734663fc5c0ea47b27ad301fc Mon Sep 17 00:00:00 2001 From: Tim Moore Date: Thu, 9 Mar 2017 04:05:33 +1100 Subject: [PATCH] Website fixes post 1.3.1 and 1.2.3 (#44) * Update previous stable release to 1.2.3 * Fix up HTML formatting * Correct the Maven documentation * Correct the sbt Java documentation Also inserts the current stable Lagom release rather than linking to the documentation index. * Correct the sbt Scala documentation Also inserts the current stable Lagom release rather than linking to the documentation index. * Wrap long lines --- .../lagom/docs/DocumentationGenerator.scala | 2 +- .../lagom/docs/getstartedjava.scala.html | 261 ++++++++++-------- .../lagom/docs/getstartedscala.scala.html | 94 ++++--- 3 files changed, 215 insertions(+), 142 deletions(-) diff --git a/src/main/scala/com/lightbend/lagom/docs/DocumentationGenerator.scala b/src/main/scala/com/lightbend/lagom/docs/DocumentationGenerator.scala index c26e88c96ff..1329923c08f 100644 --- a/src/main/scala/com/lightbend/lagom/docs/DocumentationGenerator.scala +++ b/src/main/scala/com/lightbend/lagom/docs/DocumentationGenerator.scala @@ -29,7 +29,7 @@ object DocumentationGenerator extends App { // This impacts what gets displayed on the main documentation index. val stableVersions = Seq( VersionSummary("1.3.x", s"Lagom $currentLagomVersion (current stable release)"), - VersionSummary("1.2.x", s"Lagom 1.2.2 (previous stable release)") + VersionSummary("1.2.x", s"Lagom 1.2.3 (previous stable release)") ) val previewVersions = Seq( diff --git a/src/main/twirl/com/lightbend/lagom/docs/getstartedjava.scala.html b/src/main/twirl/com/lightbend/lagom/docs/getstartedjava.scala.html index a2246171250..8b3a7162af5 100644 --- a/src/main/twirl/com/lightbend/lagom/docs/getstartedjava.scala.html +++ b/src/main/twirl/com/lightbend/lagom/docs/getstartedjava.scala.html @@ -15,58 +15,43 @@

Using Lagom with Java

-
- +

You can use Maven or sbt to build services you create with the Lagom Java API. - (If you aren’t using one of these tools already, see this information to - help you choose - between sbt and - Maven.) The Lagom development environment runs on Windows, Mac, and Linux operating systems. - Try it from the command line to get started and later integrate your - project into an IDE. Maven and sbt plugins make it especially easy to integrate the Lagom development environment with Eclipse or IntelliJ IDEA.

- -

The following screen shows a successful run of the Lagom development - environment with Maven: -

-
- -
- - -
-

-

- -
- - - - -
+ (If you aren’t using one of these tools already, see this information to + help you choose between sbt and + Maven.) The Lagom development environment runs on + Windows, Mac, and Linux operating systems. Try it from the command line to get started and later + integrate your project into an IDE. Maven and sbt plugins make it especially easy to integrate + the Lagom development environment with Eclipse or IntelliJ IDEA. +

+ +

+ The following screen shows a successful run of the Lagom development environment with Maven: +

+
+ +
+ +
+ +
-
-

Jump to information on getting started with:
Maven sbt -

-

-

-

-

-
-
+
-
+
-
+ +
- +

Using Lagom with Java and Maven

@@ -79,66 +64,93 @@

Using Lagom with Java and Maven

- If you have the prerequisites installed and are familiar with Maven, - create a Hello World project using the commands below. Otherwise, see detailed instructions - for help setting up the prerequisites and getting started. + If you have the prerequisites installed and are familiar with Maven, create a Hello World + project using the commands below. Otherwise, see + detailed + instructions for help setting up the prerequisites and getting started.

  1. - +

    From a command prompt, create a new project by entering the following (all on one line): - +

    - 
    mvn archetype:generate -DarchetypeGroupId=com.lightbend.lagom -DarchetypeArtifactId=maven-archetype-lagom-java -DarchetypeVersion=1.3.0
    + 
    mvn archetype:generate -DarchetypeGroupId=com.lightbend.lagom -DarchetypeArtifactId=maven-archetype-lagom-java -DarchetypeVersion=@context.currentLagomVersion
    2. -
  2. - Maven prompts you for: -

    • The number corresponding with the lagom archetype, at this time only one is available, enter the number 1 to select it.
      • -
    • The Lagom version, press Enter to accept the default.
      • -
    • groupId — becomes the package name, typically something like com.example.com.
      • -
    • artifactId — becomes the top-level folder name, for example, my-first-project.
      • -
    • version — the version for your project, press Enter to accept the default.
      • -
    • package — defaults to the same value as the groupId -

    -
  3. Enter Y to accept the values. Maven creates the project and downloads all of the necessary dependencies.
    4. +

    Maven prompts you for:

    +
      +
    • + groupId — typically something like com.example. +
      • +
    • + artifactId — becomes the top-level folder name, for example, + my-first-project. +
      • +
    • + version — the version for your project, press Enter to + accept the default. +
      • +
    • + package — defaults to the same value as the groupId +
      • +
    + +
  4. +

    + Enter Y to accept the values. Maven creates the project. +

    +

  5. Change into the top-level project folder and run it:

    - 
    mvn lagom:runAll
    -

    The runAll command starts Hello World microservices and registers them in a service directory. It also starts a web server, which enables you to test the microservices immediately.

    - + 
    mvn lagom:runAll
    + +

    + The runAll command starts Hello World microservices and registers them in a + service directory. It also starts a web server, which enables you to test the + microservices immediately. +

    +
    6. +
  6. +

    + Verify that the services are indeed up and running by invoking the hello + service endpoint from any HTTP client, such as a browser: + http://localhost:9000/api/hello/World +

    + +

    + The request returns the message Hello, World!. +

    7. -
  7. Verify that the services are indeed up and running by invoking the hello service endpoint from any HTTP client, such as a browser: - - - http://localhost:9000/api/hello/World - - The request returns the message Hello, World!.
    8. -
-

Congratulations! You've created and run your first Lagom system. - See the documentation - to understand your new project.

- - + +

- + Congratulations! You've created and run your first Lagom system. See + the + documentation to understand your new project.

+ @* +

+ +

+ *@ +
-
-

+
- +
-
+
+

Using Lagom with Java and sbt

@@ -151,44 +163,75 @@

Using Lagom with Java and sbt

- If you have the prerequisites installed and are familiar with sbt, follow the steps below. Otherwise, see detailed instructions - for help setting up the prerequisites and getting started. + If you have the prerequisites installed and are familiar with sbt, follow the steps below. + Otherwise, see + detailed + instructions for help setting up the prerequisites and getting started.

-
    -
  1. - From a command prompt, create and run a new project by entering the following: -
    2. - - 
    sbt new lagom/lagom-java.g8
    - -
  2. The sbt Lagom template prompts for the following parameters. Press Enter to accept the defaults or specify your own values:

    -
      -
    • name - Becomes the name of the top-level directory.
      • -
    • organization - Used as a package name.
      • -
    • version - A version number for your system.
      • -
    • lagom-version - The version number of Lagom. Be sure to use the current stable release
    -

    When you finish, sbt downloads all of the project dependencies.

    -
    3. - -
  3. Change into the top-level directory of the project you just created. For example, if you used the default name, hello: -

    cd hello

    4. - -
  4. Start sbt and the Lagom development environment: - sbt runAll
    5. -
  5. Verify that the services are indeed up and running by invoking the hello service endpoint from any HTTP client, such as a browser: - + +
      +
    1. +

      + From a command prompt, create and run a new project by entering the following: +

      + + 
      sbt new lagom/lagom-java.g8
      +
      2. +
    2. +

      + The sbt Lagom template prompts for the following parameters. Press Enter to + accept the defaults or specify your own values: +

      +
        +
      • + name - Becomes the name of the top-level directory. +
        • +
      • + organization - Used as a package name. +
        • +
      • + version - A version number for your system. +
        • +
      • + lagom_version - The version number of Lagom. Be sure to use the current + stable release (@context.currentLagomVersion) +
        • +
      +
      3. +
    3. +

      + Change into the top-level directory of the project you just created. For example, if you + used the default name, hello: +

      + 
      cd hello
      +
      4. +
    4. +

      + Start sbt and the Lagom development environment: +

      + 
      sbt runAll
      +
      5. +
    5. +

      + Verify that the services are indeed up and running by invoking the hello + service endpoint from any HTTP client, such as a browser: + http://localhost:9000/api/hello/World +

      + +

      + The request returns the message Hello, World!. +

      +
      6. +
    +

    - http://localhost:9000/api/hello/World + Congratulations! You've created and run your first Lagom system. See + the + documentation to understand your new project.

    - The request returns the message Hello, World!.
    6. -
-

Congratulations! You've created and run your first Lagom system. See the documentation - to understand your new project.

- -
- +
diff --git a/src/main/twirl/com/lightbend/lagom/docs/getstartedscala.scala.html b/src/main/twirl/com/lightbend/lagom/docs/getstartedscala.scala.html index 15fe1af1310..a5c849256cc 100644 --- a/src/main/twirl/com/lightbend/lagom/docs/getstartedscala.scala.html +++ b/src/main/twirl/com/lightbend/lagom/docs/getstartedscala.scala.html @@ -15,8 +15,7 @@

Using Lagom with Scala

-
- +

Prerequisites for using Lagom with Scala: @@ -29,40 +28,71 @@

Using Lagom with Scala

If you have the prerequisites installed and are familiar with sbt, - follow the steps below. Otherwise, see detailed instructions - for help setting up the prerequisites and getting started. + follow the steps below. Otherwise, see + detailed + instructions for help setting up the prerequisites and getting started.

-
    -
  1. - From a command prompt, enter the following to create a new Lagom project: -
    2. - 
    sbt new lagom/lagom-java.g8
    - -
  2. The sbt Lagom template prompts for the following parameters. Press Enter to accept the defaults or specify your own values:

    -
      -
    • name - Becomes the name of the top-level directory.
      • -
    • organization - Used as a package name.
      • -
    • version - A version number for your system.
      • -
    • lagom-version - The version number of Lagom. Be sure to use the current stable release
    -

    When you finish, sbt downloads all of the project dependencies.

    -
    3. - -
  3. Change into the top-level directory of the project you just created. For example, if you used the default name, hello: - cd hello
    4. - -
  4. Start sbt and the Lagom development environment: - sbt runAll
    5. - -
  5. Verify that the services are indeed up and running by invoking the hello service endpoint from any HTTP client, such as a browser: - +
      +
    1. +

      + From a command prompt, enter the following to create a new Lagom project: +

      + + 
      sbt new lagom/lagom-scala.g8
      +
      2. + +
    2. +

      + The sbt Lagom template prompts for the following parameters. Press Enter to + accept the defaults or specify your own values: +

      +
        +
      • + name - Becomes the name of the top-level directory. +
        • +
      • + organization - Used as a package name. +
        • +
      • + version - A version number for your system. +
        • +
      • + lagom_version - The version number of Lagom. Be sure to use the current + stable release (@context.currentLagomVersion) +
        • +
      +
      3. +
    3. +

      + Change into the top-level directory of the project you just created. For example, if you + used the default name, hello: +

      + 
      cd hello
      +
      4. +
    4. +

      + Start sbt and the Lagom development environment: +

      + 
      sbt runAll
      +
      5. +
    5. +

      + Verify that the services are indeed up and running by invoking the hello + service endpoint from any HTTP client, such as a browser: + http://localhost:9000/api/hello/World +

      + +

      + The request returns the message Hello, World!. +

      +
      6. +

    - http://localhost:9000/api/hello/World + Congratulations! You've created and run your first Lagom system. See + the + documentation to understand your new project.

    - The request returns the message Hello, World!.
    6. -
-

Congratulations! You've created and run your first Lagom system. See the documentation - to understand your new project.