Skip to content

Commit b3a623a

Browse files
authored
Merge pull request quarkusio#36465 from gsmet/add-extensions
Be more consistent in guides when creating projects/adding extensions
2 parents 89c47f4 + baf0b76 commit b3a623a

File tree

6 files changed

+105
-33
lines changed

6 files changed

+105
-33
lines changed

docs/src/main/asciidoc/liquibase-mongodb.adoc

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -33,40 +33,32 @@ To start using the Liquibase MongoDB Extension with your project, you just need
3333
* activate the `migrate-at-start` option to migrate the schema automatically or inject the `Liquibase` object and run
3434
your migration as you normally do.
3535

36-
In your `pom.xml`, add the following dependencies:
36+
You can add the `liquibase-mongodb` extension
37+
to your project by running the following command in your project base directory:
3738

38-
* the Liquibase MongoDB extension
39-
* the MongoDB client extension
39+
:add-extension-extensions: liquibase-mongodb
40+
include::{includes}/devtools/extension-add.adoc[]
41+
42+
This will add the following to your build file:
4043

4144
[source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"]
4245
.pom.xml
4346
----
44-
<!-- Liquibase MongoDB -->
4547
<dependency>
4648
<groupId>io.quarkus</groupId>
4749
<artifactId>quarkus-liquibase-mongodb</artifactId>
4850
</dependency>
49-
50-
<!-- MongoDB client dependency -->
51-
<dependency>
52-
<groupId>io.quarkus</groupId>
53-
<artifactId>quarkus-mongodb-client</artifactId>
54-
</dependency>
5551
----
5652

5753
[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"]
5854
.build.gradle
5955
----
60-
// Liquibase MongoDB
6156
implementation("io.quarkus:quarkus-liquibase-mongodb")
62-
63-
// MongoDB client dependency
64-
implementation("io.quarkus:quarkus-mongodb-client")
6557
----
6658

67-
Liquibase MongoDB extension support relies on the Quarkus MongoDB client config.
59+
The Liquibase MongoDB extension support relies on the Quarkus MongoDB client config.
6860
For the time being, it does not support multiple clients.
69-
First, you need to add the MongoDB config to the `{config-file}` file
61+
You need to add the MongoDB config to the `{config-file}` file
7062
in order to allow Liquibase to manage the schema.
7163

7264
The following is an example for the `{config-file}` file:

docs/src/main/asciidoc/mailer.adoc

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,19 +40,45 @@ Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {q
4040

4141
The solution is located in the `mailer-quickstart` link:{quickstarts-tree-url}/mailer-quickstart[directory].
4242

43-
== Creating the Maven Project
43+
== Create the Maven Project
4444

45-
First, we need a project.
46-
Open your browser to https://code.quarkus.io and select the following extensions:
45+
First, we need a new project. Create a new project with the following command:
4746

48-
1. RESTEasy Reactive - we use it to expose our HTTP endpoint
49-
2. Mailer - which offer the possibility to send emails
50-
3. Qute - the Quarkus template engine
47+
:create-app-artifact-id: mailer-quickstart
48+
:create-app-extensions: resteasy-reactive,mailer,qute
49+
include::{includes}/devtools/create-app.adoc[]
50+
51+
This command generates a Maven structure including the following extensions:
52+
53+
* RESTEasy Reactive used to expose REST endpoints
54+
* Mailer so that we can send emails
55+
* Qute, our template engine
56+
57+
If you already have your Quarkus project configured, you can add the `mailer` extension
58+
to your project by running the following command in your project base directory:
59+
60+
:add-extension-extensions: mailer
61+
include::{includes}/devtools/extension-add.adoc[]
62+
63+
This will add the following to your `pom.xml`:
64+
65+
[source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"]
66+
.pom.xml
67+
----
68+
<dependency>
69+
<groupId>io.quarkus</groupId>
70+
<artifactId>quarkus-mailer</artifactId>
71+
</dependency>
72+
----
73+
74+
[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"]
75+
.build.gradle
76+
----
77+
implementation("io.quarkus:quarkus-mailer")
78+
----
5179

52-
Alternatively, this https://code.quarkus.io/?a=quarkus-mailer-getting-started&nc=true&e=resteasy-reactive&e=qute&e=mailer&extension-search=mail[link] pre-configures the application.
53-
Click on "Generate your application", download the zip file and unzip it on your file system.
5480
Open the generated project in your IDE.
55-
In a terminal, navigate to the project and start dev mode:
81+
In a terminal, navigate to the project and start your application in dev mode:
5682

5783
include::{includes}/devtools/dev.adoc[]
5884

docs/src/main/asciidoc/picocli.adoc

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,31 @@ Quarkus provides support for using Picocli. This guide contains examples of `pic
1616

1717
IMPORTANT: If you are not familiar with the Quarkus Command Mode, consider reading the xref:command-mode-reference.adoc[Command Mode reference guide] first.
1818

19-
== Configuration
19+
== Extension
2020

2121
Once you have your Quarkus project configured you can add the `picocli` extension
2222
to your project by running the following command in your project base directory.
2323

2424
:add-extension-extensions: picocli
2525
include::{includes}/devtools/extension-add.adoc[]
2626

27-
This will add the following to your `pom.xml`:
27+
This will add the following to your build file:
2828

29-
[source,xml]
29+
[source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"]
30+
.pom.xml
3031
----
3132
<dependency>
3233
<groupId>io.quarkus</groupId>
3334
<artifactId>quarkus-picocli</artifactId>
3435
</dependency>
3536
----
3637

38+
[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"]
39+
.build.gradle
40+
----
41+
implementation("io.quarkus:quarkus-picocli")
42+
----
43+
3744
== Simple command line application
3845

3946
Simple PicocliApplication with only one `Command` can be created as follows:

docs/src/main/asciidoc/rabbitmq.adoc

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,33 @@ include::{includes}/devtools/create-app.adoc[]
6161
This command creates the project structure and select the two Quarkus extensions we will be using:
6262

6363
1. The Reactive Messaging RabbitMQ connector
64-
2. RESTEasy Reactive and it's Jackson support to handle JSON payloads
64+
2. RESTEasy Reactive and its Jackson support to handle JSON payloads
65+
66+
[TIP]
67+
====
68+
If you already have your Quarkus project configured, you can add the `smallrye-reactive-messaging-rabbitmq` extension
69+
to your project by running the following command in your project base directory:
70+
71+
:add-extension-extensions: smallrye-reactive-messaging-rabbitmq
72+
include::{includes}/devtools/extension-add.adoc[]
73+
74+
This will add the following to your `pom.xml`:
75+
76+
[source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"]
77+
.pom.xml
78+
----
79+
<dependency>
80+
<groupId>io.quarkus</groupId>
81+
<artifactId>quarkus-smallrye-reactive-messaging-rabbitmq</artifactId>
82+
</dependency>
83+
----
84+
85+
[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"]
86+
.build.gradle
87+
----
88+
implementation("io.quarkus:quarkus-smallrye-reactive-messaging-rabbitmq")
89+
----
90+
====
6591

6692
To create the _processor_ project, from the same directory, run:
6793

docs/src/main/asciidoc/rest-client-multipart.adoc

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,36 @@ The solution is located in the `rest-client-multipart-quickstart` link:{quicksta
4242

4343
First, we need a new project. Create a new project with the following command:
4444

45-
46-
4745
:create-app-artifact-id: rest-client-multipart-quickstart
4846
:create-app-extensions: rest-client,resteasy,resteasy-multipart
4947
include::{includes}/devtools/create-app.adoc[]
5048

51-
This command generates the Maven project with a REST endpoint and imports the `rest-client` and `resteasy` extensions.
49+
This command generates a Maven project with a REST endpoint and imports the `rest-client` and `resteasy` extensions.
5250
It also adds the `resteasy-multipart` extension to support `multipart/form-data` requests.
5351

52+
If you already have your Quarkus project configured, you can add the `resteasy-multipart` extension
53+
to your project by running the following command in your project base directory:
54+
55+
:add-extension-extensions: resteasy-multipart
56+
include::{includes}/devtools/extension-add.adoc[]
57+
58+
This will add the following to your build file:
59+
60+
[source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"]
61+
.pom.xml
62+
----
63+
<dependency>
64+
<groupId>io.quarkus</groupId>
65+
<artifactId>quarkus-resteasy-multipart</artifactId>
66+
</dependency>
67+
----
68+
69+
[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"]
70+
.build.gradle
71+
----
72+
implementation("io.quarkus:quarkus-resteasy-multipart")
73+
----
74+
5475
== Setting up the model
5576

5677
In this guide we will be demonstrating how to invoke a REST service accepting `multipart/form-data` input.

docs/src/main/asciidoc/validation.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ to your project by running the following command in your project base directory:
5252
:add-extension-extensions: hibernate-validator
5353
include::{includes}/devtools/extension-add.adoc[]
5454

55-
The result of this command is dependent on your build tool:
55+
This will add the following to your build file:
5656

5757
[source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"]
5858
.pom.xml

0 commit comments

Comments
 (0)