Skip to content

Commit 80d48e0

Browse files
committed
Sync documentation of main branch
1 parent a724fde commit 80d48e0

File tree

4 files changed

+22
-15
lines changed

4 files changed

+22
-15
lines changed

_versions/main/guides/getting-started-dev-services.adoc

+12-12
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This guide helps you:
2727
:prerequisites-no-graalvm:
2828
include::{includes}/prerequisites.adoc[]
2929

30-
This tutorial builds on what you learned writing xref:{doc-guides}/getting-started.adoc[your first Quarkus application].
30+
This tutorial builds on what you learned writing xref:getting-started.adoc[your first Quarkus application].
3131
You will not need the code from that application, but make sure you understand the concepts.
3232

3333
== Solution
@@ -79,7 +79,7 @@ Once the application is up, visit http://localhost:8080/hello. It should show a
7979
=== Accepting user input
8080

8181
Let's make the application a bit more interactive.
82-
Open the project in your IDE and navigate to `src/main/java/org/acme/GreetingResource.java'
82+
Open the project in your IDE and navigate to `src/main/java/org/acme/GreetingResource.java`
8383
Add a query param in the `hello` method.
8484
(The `org.jboss.resteasy.reactive.RestQuery` annotation is like the Jakarta REST `@QueryParam`
8585
annotation, except you don't need to duplicate the parameter name.)
@@ -142,7 +142,7 @@ public class Greeting extends PanacheEntity {
142142
}
143143
----
144144

145-
The entity makes use of xref:{doc-guides}hibernate-orm-panache.adoc[Panache], a layer on top of Hibernate ORM.
145+
The entity makes use of xref:hibernate-orm-panache.adoc[Panache], a layer on top of Hibernate ORM.
146146
Extending `PanacheEntity` brings in a range of methods for reading, writing, and finding data.
147147
Because all the data access methods are on the `Greeting` entity, rather than on a separate data access class,
148148
this is an example of the active record pattern.
@@ -199,7 +199,7 @@ public String names() {
199199
}
200200
----
201201

202-
To try it out, visit http://localhost:8080/hello?name=Bloom, and then http://localhost/hello/names.
202+
To try it out, visit http://localhost:8080/hello?name=Bloom, and then http://localhost:8080/hello/names.
203203

204204
You should see the following message: "I've said hello to Bloom".
205205

@@ -215,11 +215,11 @@ you will start seeing failures in the Quarkus logs at this point.
215215
Reading and writing to the database seems to be working well, but that's a bit unexpected.
216216
Where did a PostgreSQL database come from? You didn't set anything up.
217217

218-
The database is being managed using xref:{docfile}/dev-services.adoc[Dev Services].
218+
The database is being managed using xref:dev-services.adoc[Dev Services].
219219
Dev Services take care of stopping and starting services needed by your application.
220220
Because you
221221
included the `jdbc-postgresql` dependency, the database is a containerised PostgreSQL database.
222-
If you'd added `jdbc-mysql` insead, you would have gotten a containerised MySQL database.
222+
If you'd added `jdbc-mysql` instead, you would have gotten a containerised MySQL database.
223223

224224
If you like, use your container tool to see what containers are running.
225225
For example, if you're using Docker, run `docker ps`, and for podman, run `podman ps`.
@@ -235,10 +235,10 @@ Quarkus will automatically stop the container when your application stops.
235235

236236
=== Initialising services
237237

238-
If you play with your code some more, you may notice that sometimes, after making an application change, http://localhost/hello/names doesn't list any names.
238+
If you play with your code some more, you may notice that sometimes, after making an application change, http://localhost:8080/hello/names doesn't list any names.
239239
What's going on? By default, in dev mode, with a Dev Services database,
240240
Quarkus configures Hibernate ORM database generation to be `drop-and-create`.
241-
See the xref:{docfile}/hibernate-orm.adoc#quarkus-hibernate-orm_quarkus.hibernate-orm.database-database-related-configuration[Hibernate configuration reference] for more details.
241+
See the xref:hibernate-orm.adoc#quarkus-hibernate-orm_quarkus.hibernate-orm.database-database-related-configuration[Hibernate configuration reference] for more details.
242242
If a code change triggers an application restart, the database tables
243243
will be dropped (deleted) and then re-created.
244244

@@ -282,7 +282,7 @@ This tells Quarkus that you don't want it to start a Dev Service,
282282
because you have your own database. You don't need to worry about starting
283283
the database, because you're just seeing how to change the configuration.
284284

285-
Visit `http://localhost:8080/hello/names`. Instead of a list of names,
285+
Visit http://localhost:8080/hello/names. Instead of a list of names,
286286
you'll get a red error screen. In the terminal where Quarkus is running.
287287
you'll see the following stack error message:
288288

@@ -310,7 +310,7 @@ but have it *only* used in production, so you could still use dev services the r
310310

311311
Add a `%prod.`
312312
prefix to the database configuration. This means the configuration
313-
only applies to the xref:{docfile}/config-reference#profiles[prod profile]
313+
only applies to the xref:config-reference.adoc#profiles[prod profile]
314314

315315
The configuration should look like this:
316316

@@ -341,6 +341,6 @@ a 'real' database, without you having to configure anything.
341341

342342
== References
343343

344-
* xref:{doc-guides}dev-services.adoc[Dev Services]
344+
* xref:dev-services.adoc[Dev Services]
345345

346-
* xref:{doc-guides}hibernate-orm-panache.adoc[Hibernate ORM with Panache]
346+
* xref:hibernate-orm-panache.adoc[Hibernate ORM with Panache]

_versions/main/guides/gradle-tooling.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -621,7 +621,7 @@ There are multiple configuration sources that influence Quarkus builds, mentione
621621
The Quarkus build uses the `prod` configuration profile:
622622

623623
1. System properties (for example `./gradlew -Dquarkus.package.type=fast-jar ...`)
624-
2. System environment (for example `QUARKUS_PACAKGE_TYPE=fast-jar ./gradlew ...`)
624+
2. System environment (for example `QUARKUS_PACKAGE_TYPE=fast-jar ./gradlew ...`)
625625
3. Configuration via the `quarkus` extensions's `quarkusBuildProperties` For example:
626626

627627
quarkus {
@@ -749,7 +749,7 @@ TIP: The Quarkus Gradle plugin detects a _CI environment_, if the `CI` environme
749749
How the various Quarkus package types are cached in non-CI and CI environments is described in the following table.
750750
Note that even if a task's output is not _cached_, the _up-to-date_ checks still apply.
751751

752-
NOTE: The Quarkus application build is split across three tasks. The `quarkusBuild` taskl is responsible to _provide_
752+
NOTE: The Quarkus application build is split across three tasks. The `quarkusBuild` task is responsible to _provide_
753753
a built Quarkus application. The tasks `quarkusDependenciesBuild` and `quarkusAppPartsBuild` are considered internal
754754
tasks (may change at any time w/o prior notice). See below for details.
755755

_versions/main/guides/reactive-routes.adoc

+7-1
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ public void blocking(RoutingContext rc) {
138138
// ...
139139
}
140140
----
141-
When `@Blocking` is used, it ignores the `type` attribute of `@Route`.
141+
When `@Blocking` is used, the `type` attribute of the `@Route` is ignored.
142142
====
143143

144144
The `@Route` annotation is repeatable and so you can declare several routes for a single method:
@@ -164,6 +164,12 @@ String person() {
164164
----
165165
<1> If the `accept` header matches `text/html`, we set the content type automatically to `text/html`.
166166

167+
=== Executing route on a virtual thread
168+
169+
You can annotate a route method with `@io.smallrye.common.annotation.RunOnVirtualThread` in order to execute it on a virtual thread.
170+
However, keep in mind that not everything can run safely on virtual threads.
171+
You should read the xref:virtual-threads.adoc#run-code-on-virtual-threads-using-runonvirtualthread[Virtual thread support reference] carefully and get acquainted with all the details.
172+
167173
=== Handling conflicting routes
168174

169175
You may end up with multiple routes matching a given path.

_versions/main/guides/virtual-threads.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ In this scenario, it is worse than useless to have thousands of threads if we ha
7979
Even worse, when running a CPU-bound workload on a virtual thread, the virtual thread monopolizes the carrier thread on which it is mounted.
8080
It will either reduce the chance for the other virtual thread to run or will start creating new carrier threads, leading to high memory usage.
8181

82+
[[run-code-on-virtual-threads-using-runonvirtualthread]]
8283
== Run code on virtual threads using @RunOnVirtualThread
8384

8485
In Quarkus, the support of virtual thread is implemented using the link:{runonvthread}[@RunOnVirtualThread] annotation.

0 commit comments

Comments
 (0)