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
5 changes: 3 additions & 2 deletions docs/src/main/asciidoc/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,14 @@ adopted.

== References

The following links provide background on the general Red Hat conventions and Asciidoc syntax.
The following links provide background on the general conventions and Asciidoc syntax.

* https://redhat-documentation.github.io/asciidoc-markup-conventions/[AsciiDoc Mark-up Quick Reference for Red Hat Documentation]
* https://redhat-documentation.github.io/asciidoc-markup-conventions/[AsciiDoc Mark-up Quick Reference for Documentation]
* http://asciidoctor.org/docs/user-manual/[Asciidoctor User Manual]
* http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[AsciiDoc Syntax Quick Reference]

== Variables for Use in Documents

The following variables externalize key information that can change over time, and so references
to such information should be done by using the variable inside of {} curly brackets. The
complete list of externalized variables for use is given in the following table:
Expand Down
8 changes: 5 additions & 3 deletions docs/src/main/asciidoc/building-native-image-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ 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-runner`.
You can run it using: `target/quarkus-quickstart-runner.jar`.
You can run it using: `./target/quarkus-quickstart-runner`.

== Testing the native executable

Expand Down Expand Up @@ -177,8 +177,10 @@ IMPORTANT: Before going further, be sure to have a working Docker environment.

You can run the application in a Docker container using the JAR produced by the Quarkus Maven Plugin.
However, in this guide we focus on creating a Docker image using the produced native executable.
Because the Docker container may not use the same _executable_ format as the one produced by default, we must instruct the Maven build to produce an
executable from inside a Docker container:

By default, the native image is tailored for your operating system (Linux, macOS, Windows etc).
Because the Docker container may not use the same _executable_ format as the one produced by your operating system,
we will instruct the Maven build to produce an executable from inside a Docker container:

[source, bash]
----
Expand Down
14 changes: 5 additions & 9 deletions docs/src/main/asciidoc/getting-started-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -107,12 +107,6 @@ In addition, you can see the `quarkus-maven-plugin` responsible of the packaging
</build>
----

[NOTE]
.What's Quarkus?
====
Quarkus can be seen as {project-name} core.
====

If we focus on the dependencies section, you can see 2 extensions allowing the development of REST applications:

[source,xml]
Expand All @@ -130,7 +124,7 @@ If we focus on the dependencies section, you can see 2 extensions allowing the d
[NOTE]
.What's ArC?
====
ArC is a CDI-based dependency injection solution - see also link:cdi-reference.html[Contexts and Dependency Injection].
ArC is a CDI-based dependency injection solution tailored for Quarkus architecture - see also link:cdi-reference.html[Contexts and Dependency Injection].
====

=== The JAX-RS resources
Expand Down Expand Up @@ -163,7 +157,7 @@ It's a very simple REST endpoint, returning "hello" to requests on "/hello".
.Differences with vanilla Jax-RS
====
With Quarkus no need to create an `Application` class. It's supported but not required. In addition, only one instance
of the resource is created and not one per request. You can configure this using the different `XScoped` annotations.
of the resource is created and not one per request. You can configure this using the different `*Scoped` annotations (`ApplicationScoped`, `RequestScoped`, etc).
====

== Running the application
Expand Down Expand Up @@ -263,7 +257,9 @@ Then check that http://localhost:8080/hello/greeting/quarkus returns `hello quar
== Development Mode

`quarkus:dev` runs Quarkus in development mode. This enables hot deployment with background compilation, which means
that when you modify your Java files and refresh your browser these changes will automatically take effect. The act of
that when you modify your Java files your resource files and refresh your browser these changes will automatically take effect.
This works too for resource files like the configuration property file.
The act of
refreshing the browser triggers a scan of the workspace, and if any changes are detected the Java files are compiled,
and the application is redeployed, then your request is serviced by the redeployed application. If there are any issues
with compilation or deployment an error page will let you know.
Expand Down