Skip to content

Commit e6feade

Browse files
committed
improve the docs
1 parent ba4d296 commit e6feade

2 files changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ Further documentation of each Custom Resource can be found here:
1818

1919
The following example shows how to set up a connection to a PostgreSQL cluster, create a database and schema, a login role (user), and configure permissions.
2020

21+
If you want to try this out locally, you can follow the [Docker Environment](docs/docker-environment.md) guide.
22+
2123
```yaml
2224
# Define a ClusterConnection resource to connect to a PostgreSQL cluster.
2325
---
@@ -159,8 +161,10 @@ make run
159161
./gradlew :operator:quarkusDev
160162
```
161163

162-
The app service will be available at http://localhost:8080,
163-
and you can also use the Dev UI (available in dev mode only) at <http://localhost:8080/q/dev/>.
164+
The app service will be available at [http://localhost:8080](http://localhost:8080).
165+
166+
You can also use the Dev UI (available in dev mode only) at [http://localhost:8080/q/dev-ui/welcome](http://localhost:8080/q/dev-ui/welcome).
167+
There you can find a set of guides for the used extensions in this project to get up-to-speed faster.
164168

165169
To execute the test without continuous testing in the dev mode, you can run the following command:
166170

docs/docker-environment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Docker Environment
22

3-
This example demonstrates how to set up a local development environment using Quarkus Dev Services to test the Operator manually.
3+
This example demonstrates how to set up a local development environment using Quarkus Dev Services to test the Operator manually.
44
As the K3s cluster port and the secrets change on every `./gradlew :operator:quarkusDev` run, you will have to manually update the port and secrets in the `~/.kube/config` every time.
55

66
## 1. Configure Kubeconfig from Dev Services

0 commit comments

Comments
 (0)