Skip to content

Commit

Permalink
Merge pull request #36474 from LeonorLunatech/fix-doc-getting-started…
Browse files Browse the repository at this point in the history
…-dev-services-links

Fix some issues in getting-started-dev-services
  • Loading branch information
gsmet authored Oct 14, 2023
2 parents e337149 + b865f85 commit d23917b
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/src/main/asciidoc/getting-started-dev-services.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This guide helps you:
:prerequisites-no-graalvm:
include::{includes}/prerequisites.adoc[]

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

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

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

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

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

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

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

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

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

=== Initialising services

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.
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.
What's going on? By default, in dev mode, with a Dev Services database,
Quarkus configures Hibernate ORM database generation to be `drop-and-create`.
See the xref:{docfile}/hibernate-orm.adoc#quarkus-hibernate-orm_quarkus.hibernate-orm.database-database-related-configuration[Hibernate configuration reference] for more details.
See the xref:hibernate-orm.adoc#quarkus-hibernate-orm_quarkus.hibernate-orm.database-database-related-configuration[Hibernate configuration reference] for more details.
If a code change triggers an application restart, the database tables
will be dropped (deleted) and then re-created.

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

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

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

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

The configuration should look like this:

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

== References

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

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

0 comments on commit d23917b

Please sign in to comment.