Skip to content

Commit 0cc2a2a

Browse files
authored
Merge pull request #118 from redhat-developer-demos/doc
small improvements to tutorial
2 parents 4a2f3f0 + 3b0ff4d commit 0cc2a2a

4 files changed

Lines changed: 41 additions & 13 deletions

File tree

.devcontainer/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
FROM quay.io/rhdevelopers/quarkus-maven-repo-cache as cachier
22

33

4-
FROM quay.io/rhdevelopers/tutorial-tools:0.0.6
4+
FROM quay.io/rhdevelopers/tutorial-tools:0.0.7
55

66
COPY --from=cachier /work/m2repo $DEVELOPER_HOME/.m2/repository
77

documentation/modules/ROOT/pages/_partials/compile-and-run.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[tabs]
1+
[tabs%sync]
22
====
33
JVM mode::
44
+

documentation/modules/ROOT/pages/basics.adoc

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@
44

55
== Creating a Quarkus Application
66

7-
[tabs]
7+
[tabs%sync]
88
====
9+
910
Maven::
1011
+
1112
--
@@ -19,12 +20,11 @@ mvn "io.quarkus.platform:quarkus-maven-plugin:create" \
1920
-Dextensions='resteasy-reactive'
2021
cd {project-name}
2122
----
22-
2323
--
2424
Quarkus CLI::
2525
+
2626
--
27-
The quarkus command lets you create projects, manage extensions and do essential build and dev commands using the underlying project build tool.
27+
The quarkus CLI tool lets you create projects, manage extensions and do essential dev, build and deploy commands using the underlying project build tool in a simplified way.
2828
2929
Follow these instructions to install Quarkus CLI: https://quarkus.io/guides/cli-tooling
3030
@@ -37,7 +37,6 @@ quarkus create app \
3737
com.redhat.developers:tutorial-app:1.0-SNAPSHOT
3838
cd {project-name}
3939
----
40-
4140
--
4241
====
4342

@@ -87,7 +86,7 @@ When running this test, the application is started once, then all tests are exec
8786

8887
You can run the test in your IDE or by running the following:
8988

90-
[tabs]
89+
[tabs%sync]
9190
====
9291
Maven::
9392
+
@@ -136,7 +135,7 @@ This is probably one of the best features of Quarkus: enabling a very fast and p
136135

137136
Let's start the _Live Coding_ mode by invoking `mvn`. You probably won't need to stop/start Quarkus again during this tutorial:
138137

139-
[tabs]
138+
[tabs%sync]
140139
====
141140
Maven::
142141
+

documentation/modules/ROOT/pages/setup.adoc

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ include::../_attributes.adoc
44

55
== IDE
66

7-
You can use any Java IDE for this tutorial but if you didn't try it before, we recommend https://code.visualstudio.com/download[VS Code, window="_blank"] with the https://marketplace.visualstudio.com/items?itemName=redhat.java[Language Support for Java(TM) by Red Hat, window="_blank"] and the https://marketplace.visualstudio.com/items?itemName=redhat.vscode-quarkus[Quarkus, window="_blank"] extensions.
7+
You can use any Java IDE for this tutorial but if you haven't tried it before, we recommend https://code.visualstudio.com/download[VS Code, window="_blank"] with the https://marketplace.visualstudio.com/items?itemName=redhat.java[Language Support for Java(TM) by Red Hat, window="_blank"] and the https://marketplace.visualstudio.com/items?itemName=redhat.vscode-quarkus[Quarkus, window="_blank"] extensions.
88

99
[TIP]
1010
====
@@ -14,7 +14,7 @@ which allows you to run this entire tutorial within a container that will have a
1414

1515
== CLI Tools
1616

17-
The following CLI tools are required for running the exercises in this tutorial.
17+
The following CLI tools are recommended for running the exercises in this tutorial.
1818

1919
////
2020
ifndef::workshop[]
@@ -27,7 +27,7 @@ endif::workshop[]
2727
GraalVM is only required if you intend to build a native image for your local operating system. If you want to create a container using a native image, you can use the Quarkus feature for this and don't need to install GraalVM locally.
2828
====
2929

30-
NOTE: You can also use Docker instead of Podman. The advantage of Podman is that it is 100% Free Open Source and does not need to run with elevated privileges. Just use 'podman' instead of 'docker' throughout the tutorial's instructions, or easier yet, alias docker=podman to automatically use podman under the hood for docker commands.
30+
NOTE: * You can also use Docker instead of Podman. The advantage of Podman is that it is 100% Free Open Source and does not need to run with elevated privileges. Just use 'podman' instead of 'docker' throughout the tutorial's instructions, or easier yet, alias docker=podman to automatically use podman under the hood for docker commands.
3131

3232
[tabs]
3333
====
@@ -36,11 +36,12 @@ Local Installation::
3636
--
3737
Please have them installed and configured before you get started with any of the tutorial chapters.
3838
39+
3940
[options="header"]
4041
|===
4142
|**Tool**|**macOS**|**Fedora**|**Windows**
4243
43-
| **Podman Desktop**
44+
| **Podman Desktop* **
4445
| https://podman-desktop.io/downloads[Podman Desktop for Mac, window="_blank"]
4546
| https://podman-desktop.io/downloads[Podman Desktop for Linux, window="_blank"]
4647
| https://podman-desktop.io/downloads[Podman Desktop for Windows, window="_blank"]
@@ -61,6 +62,21 @@ Please have them installed and configured before you get started with any of the
6162
| https://github.com/graalvm/graalvm-ce-builds/releases/download/vm-{graalvm-version}/graalvm-ce-java17-windows-amd64-{graalvm-version}.zip[GraalVM Community Edition {graalvm-version}]
6263
6364
|===
65+
66+
[TIP]
67+
=====
68+
You can also install Java and Maven using https://sdkman.io[SDKMAN!]. This allows easy version/distribution switching (and you can install the Quarkus CLI with it as well)
69+
[.console-input]
70+
[source,bash,subs="+macros,+attributes"]
71+
----
72+
curl -s "https://get.sdkman.io" | bash
73+
source "$HOME/.sdkman/bin/sdkman-init.sh"
74+
75+
sdk install java
76+
sdk install maven
77+
sdk install quarkus
78+
----
79+
=====
6480
--
6581
Container Image::
6682
+
@@ -77,12 +93,25 @@ mkdir work
7793
docker run -ti -p 8080:8080 -v `pwd`/work:/work \
7894
-v `mvn help:evaluate -Dexpression=settings.localRepository | grep \
7995
-v '\[INFO\]' | grep -v '\[WARNING\]'`:/opt/developer/.m2/repository \
80-
--rm quay.io/rhdevelopers/tutorial-tools bash
96+
--rm quay.io/rhdevelopers/tutorial-tools:0.0.7 bash
8197
8298
# -p will map Quarkus running in the container to your host port
8399
# -v `pwd`... will map the host work subdirectory to the container /work directory, this is where you will create your application
84100
# -v `mvn ...` will map your ~/.m2/repository of your host to the container repository to save downloading again between image runs
85101
-----
102+
103+
[TIP]
104+
=====
105+
Installing https://sdkman.io[SDKMAN!] in the container will allow you to install the Quarkus CLI very easily:
106+
[.console-input]
107+
[source,bash,subs="+macros,+attributes"]
108+
----
109+
curl -s "https://get.sdkman.io" | bash
110+
source "$HOME/.sdkman/bin/sdkman-init.sh"
111+
112+
sdk install quarkus
113+
----
114+
=====
86115
--
87116
====
88117

0 commit comments

Comments
 (0)