Skip to content

Commit 0dbec0d

Browse files
committed
Explain where the links go for clarity
1 parent bac6022 commit 0dbec0d

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

docs/src/main/asciidoc/dev-mode-differences.adoc

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,17 @@ This document explains how the dev mode in Quarkus differs from a production app
1313

1414
== Intro
1515

16-
Quarkus provides a dev mode (explained in more detail xref:maven-tooling.adoc#dev-mode[here] and link:gradle-tooling#dev-mode[here]) which greatly aids
16+
Quarkus provides a dev mode which greatly aids
1717
during development but should *NEVER* be used in production.
1818

19+
These pages have instruction on how to use dev mode with xref:maven-tooling.adoc#dev-mode[Maven], link:gradle-tooling#dev-mode[Gradle] or with the xref:cli-tooling#development-mode[Quarkus CLI].
20+
1921
[[architectural-differences]]
2022
== Architectural differences
2123

2224
Feature sets aside, the Quarkus application that is run under dev mode differs architecturally from the production application (i.e. the one that is run using `java -jar ...`).
2325

24-
In dev mode, Quarkus uses a ClassLoader hierarchy (explained in detail xref:class-loading-reference.adoc[here]) that enables the live reload of user code
26+
In dev mode, Quarkus uses a ClassLoader hierarchy (explained in detail in the xref:class-loading-reference.adoc[class loading reference]) that enables the live reload of user code
2527
without requiring a rebuild and restart of the application.
2628

2729
In a production application, the aforementioned class loading infrastructure is entirely absent - there is a single, purpose built ClassLoader that loads (almost) all classes and dependencies.
@@ -52,28 +54,28 @@ In an effort to make development errors very easy to diagnose, Quarkus provides
5254

5355
=== Database import scripts
5456

55-
The `quarkus-hibernate-orm` extension will run the `import.sql` script in `src/main/resources` when Quarkus is running in dev mode. More details can be found xref:hibernate-orm.adoc#dev-mode[here].
57+
The `quarkus-hibernate-orm` extension will run the `import.sql` script in `src/main/resources` when Quarkus is running in dev mode. More details can be found in the xref:hibernate-orm.adoc#dev-mode[Hibernate ORM guide].
5658

5759
=== Dev Services
5860

5961
When testing or running in dev mode Quarkus can even provide you with a zero config database out of the box, a feature we refer to as Dev Services.
60-
More information can be found xref:datasource.adoc#dev-services[here].
62+
More information can be found in the xref:datasource.adoc#dev-services[Datasource guide].
6163

6264
=== Swagger UI
6365

64-
The `quarkus-smallrye-openapi` extension will expose the Swagger UI when Quarkus is running in dev mode. Additional information can be found xref:openapi-swaggerui.adoc#dev-mode[here].
66+
The `quarkus-smallrye-openapi` extension will expose the Swagger UI when Quarkus is running in dev mode. Additional information can be found in the xref:openapi-swaggerui.adoc#dev-mode[Swagger UI guide].
6567

6668
=== GraphQL UI
6769

68-
The `quarkus-smallrye-graphql` extension will expose the GraphQL UI when Quarkus is running in dev mode. More details can be found xref:smallrye-graphql.adoc#ui[here].
70+
The `quarkus-smallrye-graphql` extension will expose the GraphQL UI when Quarkus is running in dev mode. More details can be found in the xref:smallrye-graphql.adoc#ui[Graphql guide].
6971

7072
=== Health UI
7173

72-
The `quarkus-smallrye-health` extension will expose the Health UI when Quarkus is running in dev mode. xref:smallrye-health.adoc#ui[This] section provides additional information.
74+
The `quarkus-smallrye-health` extension will expose the Health UI when Quarkus is running in dev mode. The xref:smallrye-health.adoc#ui[Healthcheck] section provides additional information.
7375

7476
=== Mock mailer
7577

76-
The `quarkus-mailer` extension will enable an in-memory mock mail server when Quarkus is running in dev mode. See xref:mailer-reference.adoc#testing[this] for more details.
78+
The `quarkus-mailer` extension will enable an in-memory mock mail server when Quarkus is running in dev mode. See the xref:mailer-reference.adoc#testing[Mailer guide] for more details.
7779

7880

7981
=== gRPC

0 commit comments

Comments
 (0)