Skip to content

Commit

Permalink
Fix guides code generation to be consistent with content
Browse files Browse the repository at this point in the history
  • Loading branch information
ia3andy committed Jan 20, 2021
1 parent 7159a69 commit 4db5743
Show file tree
Hide file tree
Showing 56 changed files with 103 additions and 61 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -102,21 +102,47 @@ public class CreateProjectMojo extends AbstractMojo {
@Parameter(property = "platformVersion", required = false)
private String bomVersion;

/**
* The {@link #path} will define the REST path of the generated code when picking only one of those extensions resteasy,
* resteasy-reactive and spring-web.
* <br />
* If more than one of those extensions are picked, this parameter will be ignored.
* <br />
* This is @Deprecated because using a generic path parameters with multiple example does not make sense and lead to
* confusion.
* More info: https://github.com/quarkusio/quarkus/issues/14437
* <br />
* {@code className}
*/
@Parameter(property = "path")
@Deprecated
private String path;

/**
* This parameter is only working with the RESTEasy and Spring Web extensions and is going to be removed.
* Use packageName instead.
*
* The {@link #className} will define the generated class names when picking only one of those extensions resteasy,
* resteasy-reactive and spring-web.
* <br />
* If more than one of those extensions are picked, then only the package name part will be used as {@link #packageName}
* <br />
* This is @Deprecated because using a generic className parameters with multiple example does not make sense and lead to
* confusion.
* More info: https://github.com/quarkusio/quarkus/issues/14437
* <br />
* By default, the {@link #projectGroupId} is used as package for generated classes (you can also use {@link #packageName}
* to have them different).
* <br />
* {@code className}
*/
@Parameter(property = "className")
@Deprecated
private String className;

/**
* If not set, groupId will be used
* Set the package name of the generated classes.
* <br />
* If not set, {@link #projectGroupId} will be used as {@link #packageName}
*
* {@code packageName}
*/
@Parameter(property = "packageName")
private String packageName;
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/amazon-dynamodb.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=amazon-dynamodb-quickstart \
-DclassName="org.acme.dynamodb.FruitResource" \
-Dpath="/fruits" \
-Dextensions="resteasy-jackson,amazon-dynamodb,resteasy-mutiny"
-Dextensions="resteasy,resteasy-jackson,amazon-dynamodb,resteasy-mutiny"
cd amazon-dynamodb-quickstart
----

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/amazon-kms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=amazon-kms-quickstart \
-DclassName="org.acme.kms.QuarkusKmsSyncResource" \
-Dpath="/sync" \
-Dextensions="resteasy-jackson,amazon-kms,resteasy-mutiny"
-Dextensions="resteasy,resteasy-jackson,amazon-kms,resteasy-mutiny"
cd amazon-kms-quickstart
----

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/amazon-s3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=amazon-s3-quickstart \
-DclassName="org.acme.s3.S3SyncClientResource" \
-Dpath="/s3" \
-Dextensions="resteasy-jackson,amazon-s3"
-Dextensions="resteasy,resteasy-jackson,amazon-s3"
cd amazon-s3-quickstart
----

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/amazon-ses.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=amazon-ses-quickstart \
-DclassName="org.acme.ses.QuarkusSesSyncResource" \
-Dpath="/sync" \
-Dextensions="resteasy-jackson,amazon-ses,resteasy-mutiny"
-Dextensions="resteasy,resteasy-jackson,amazon-ses,resteasy-mutiny"
cd amazon-ses-quickstart
----

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/amazon-sns.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=amazon-sns-quickstart \
-DclassName="org.acme.sns.QuarksCannonSyncResource" \
-Dpath="/sync-cannon" \
-Dextensions="resteasy-jackson,amazon-sns,resteasy-mutiny"
-Dextensions="resteasy,resteasy-jackson,amazon-sns,resteasy-mutiny"
cd amazon-sns-quickstart
----

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/amazon-sqs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=amazon-sqs-quickstart \
-DclassName="org.acme.sqs.QuarksCannonSyncResource" \
-Dpath="/sync-cannon" \
-Dextensions="resteasy-jackson,amazon-sqs,resteasy-mutiny"
-Dextensions="resteasy,resteasy-jackson,amazon-sqs,resteasy-mutiny"
cd amazon-sqs-quickstart
----

Expand Down
3 changes: 2 additions & 1 deletion docs/src/main/asciidoc/amqp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@ First, we need a new project. Create a new project with the following command:
mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectGroupId=org.acme \
-DprojectArtifactId=amqp-quickstart \
-Dextensions="amqp"
-Dextensions="amqp" \
-DnoExamples
cd amqp-quickstart
----

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/cache.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=cache-quickstart \
-DclassName="org.acme.cache.WeatherForecastResource" \
-Dpath="/weather" \
-Dextensions="cache,resteasy-jackson"
-Dextensions="resteasy,cache,resteasy-jackson"
----

This command generates the Maven project with a REST endpoint and imports the `cache` and `resteasy-jackson` extensions.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/centralized-log-management.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=gelf-logging \
-DclassName="org.acme.quickstart.GelfLoggingResource" \
-Dpath="/gelf-logging" \
-Dextensions="logging-gelf"
-Dextensions="resteasy,logging-gelf"
----

If you already have your Quarkus project configured, you can add the `logging-gelf` extension
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/deploying-to-kubernetes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=kubernetes-quickstart \
-DclassName="org.acme.rest.GreetingResource" \
-Dpath="/greeting" \
-Dextensions="kubernetes, jib"
-Dextensions="resteasy,kubernetes,jib"
cd kubernetes-quickstart
----

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/deploying-to-openshift.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=openshift-quickstart \
-DclassName="org.acme.rest.GreetingResource" \
-Dpath="/greeting" \
-Dextensions="openshift"
-Dextensions="resteasy,openshift"
cd openshift-quickstart
----
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/elasticsearch.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=elasticsearch-quickstart \
-DclassName="org.acme.elasticsearch.FruitResource" \
-Dpath="/fruits" \
-Dextensions="resteasy-jackson,elasticsearch-rest-client"
-Dextensions="resteasy,resteasy-jackson,elasticsearch-rest-client"
cd elasticsearch-quickstart
----

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/funqy-gcp-functions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=funqy-google-cloud-functions \
-DclassName="org.acme.quickstart.GreetingResource" \
-Dpath="/hello" \
-Dextensions="funqy-google-cloud-functions"
-Dextensions="resteasy,funqy-google-cloud-functions"
----

Now, let's remove what's not needed inside the generated application:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/gcp-functions-http.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=google-cloud-functions-http \
-DclassName="org.acme.quickstart.GreetingResource" \
-Dpath="/hello" \
-Dextensions="google-cloud-functions-http,resteasy-json,undertow,vertx-web,funqy-http"
-Dextensions="resteasy,google-cloud-functions-http,resteasy-json,undertow,vertx-web,funqy-http"
----

== Login to Google Cloud
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/gcp-functions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=google-cloud-functions \
-DclassName="org.acme.quickstart.GreetingResource" \
-Dpath="/hello" \
-Dextensions="google-cloud-functions"
-Dextensions="resteasy,google-cloud-functions"
----

Now, let's remove what's not needed inside the generated application:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/getting-started-reactive.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -408,7 +408,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=getting-started-reactive-crud \
-DclassName="org.acme.reactive.crud.FruitResource" \
-Dpath="/fruits" \
-Dextensions="resteasy-mutiny, resteasy-jackson, reactive-pg-client"
-Dextensions="resteasy,resteasy-mutiny,resteasy-jackson,reactive-pg-client"
cd getting-started-reactive-crud
----

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/gradle-tooling.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=my-artifactId \
-DprojectVersion=my-version \
-DclassName="org.my.group.MyResource" \
-Dextensions="resteasy-jackson" \
-Dextensions="resteasy,resteasy-jackson" \
-DbuildTool=gradle
----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=hibernate-search-orm-elasticsearch-quickstart \
-DclassName="org.acme.hibernate.search.elasticsearch.LibraryResource" \
-Dpath="/library" \
-Dextensions="hibernate-orm-panache, hibernate-search-orm-elasticsearch, resteasy-jackson, jdbc-postgresql"
-Dextensions="resteasy,hibernate-orm-panache,hibernate-search-orm-elasticsearch,resteasy-jackson,jdbc-postgresql"
cd hibernate-search-orm-elasticsearch-quickstart
----

Expand Down
6 changes: 4 additions & 2 deletions docs/src/main/asciidoc/jms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@ First, we need a new project. Create a new project with the following command:
mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectGroupId=org.acme \
-DprojectArtifactId=jms-quickstart \
-Dextensions="qpid-jms"
-Dextensions="qpid-jms" \
-DnoExamples
cd jms-quickstart
----

Expand Down Expand Up @@ -367,7 +368,8 @@ Create a new project with the following command:
mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectGroupId=org.acme \
-DprojectArtifactId=jms-quickstart \
-Dextensions="artemis-jms"
-Dextensions="artemis-jms" \
-DnoExamples
cd jms-quickstart
----

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/kafka-streams.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ Create another project like so:
mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectGroupId=org.acme \
-DprojectArtifactId=kafka-streams-quickstart-aggregator \
-Dextensions="kafka-streams,resteasy-jackson" \
-Dextensions="resteasy,kafka-streams,resteasy-jackson" \
-DnoExamples \
&& mv kafka-streams-quickstart-aggregator aggregator
----
Expand Down
3 changes: 2 additions & 1 deletion docs/src/main/asciidoc/kafka.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ First, we need a new project. Create a new project with the following command:
mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectGroupId=org.acme \
-DprojectArtifactId=kafka-quickstart \
-Dextensions="smallrye-reactive-messaging-kafka"
-Dextensions="smallrye-reactive-messaging-kafka" \
-DnoExamples
cd kafka-quickstart
----

Expand Down
3 changes: 2 additions & 1 deletion docs/src/main/asciidoc/kogito.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,8 @@ First, we need a new project. Create a new project with the following command:
mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectGroupId=org.acme \
-DprojectArtifactId=kogito-quickstart \
-Dextensions="kogito"
-Dextensions="kogito" \
-DnoExamples
cd kogito-quickstart
----

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/kotlin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=rest-kotlin-quickstart \
-DclassName="org.acme.rest.GreetingResource" \
-Dpath="/greeting" \
-Dextensions="kotlin,resteasy-jackson"
-Dextensions="resteasy,kotlin,resteasy-jackson"
cd rest-kotlin-quickstart
----

Expand Down
3 changes: 2 additions & 1 deletion docs/src/main/asciidoc/mailer.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ Create a new project with the following command:
mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectGroupId=org.acme \
-DprojectArtifactId=sending-email-quickstart \
-Dextensions="mailer"
-Dextensions="mailer" \
-DnoExamples
cd sending-email-quickstart
----

Expand Down
3 changes: 2 additions & 1 deletion docs/src/main/asciidoc/micrometer.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@ First, we need a new project. Create a new project with the following command:
mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectGroupId=org.acme \
-DprojectArtifactId=micrometer-quickstart \
-Dextensions="micrometer-registry-prometheus"
-Dextensions="micrometer-registry-prometheus" \
-DnoExamples
cd micrometer-quickstart
----

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/microprofile-fault-tolerance.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=microprofile-fault-tolerance-quickstart \
-DclassName="org.acme.microprofile.faulttolerance.CoffeeResource" \
-Dpath="/coffee" \
-Dextensions="smallrye-fault-tolerance, resteasy-jackson"
-Dextensions="resteasy,smallrye-fault-tolerance,resteasy-jackson"
cd microprofile-fault-tolerance-quickstart
----

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/microprofile-graphql.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectGroupId=org.acme \
-DprojectArtifactId=microprofile-graphql-quickstart \
-DclassName="org.acme.microprofile.graphql.FilmResource" \
-Dextensions="graphql"
-Dextensions="resteasy,graphql"
cd microprofile-graphql-quickstart
----

Expand Down
3 changes: 2 additions & 1 deletion docs/src/main/asciidoc/microprofile-metrics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ First, we need a new project. Create a new project with the following command:
mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectGroupId=org.acme \
-DprojectArtifactId=microprofile-metrics-quickstart \
-Dextensions="smallrye-metrics"
-Dextensions="smallrye-metrics" \
-DnoExamples
cd microprofile-metrics-quickstart
----

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/mongodb-panache.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=mongodb-panache-quickstart \
-DclassName="org.acme.mongodb.panache.PersonResource" \
-Dpath="/persons" \
-Dextensions="resteasy-jackson,mongodb-panache"
-Dextensions="resteasy,resteasy-jackson,mongodb-panache"
cd mongodb-panache-quickstart
----

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/mongodb.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=mongodb-quickstart \
-DclassName="org.acme.mongodb.FruitResource" \
-Dpath="/fruits" \
-Dextensions="resteasy-jackson,mongodb-client,resteasy-mutiny,context-propagation"
-Dextensions="resteasy,resteasy-jackson,mongodb-client,resteasy-mutiny,context-propagation"
cd mongodb-quickstart
----

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/neo4j.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectGroupId=org.acme \
-DprojectArtifactId=neo4j-quickstart \
-DclassName="org.acme.datasource.GreetingResource" \
-Dextensions="neo4j,resteasy-jackson"
-Dextensions="resteasy,neo4j,resteasy-jackson"
cd neo4j-quickstart
----

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/openapi-swaggerui.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=openapi-swaggerui-quickstart \
-DclassName="org.acme.openapi.swaggerui.FruitResource" \
-Dpath="/fruits" \
-Dextensions="resteasy-jackson"
-Dextensions="resteasy,resteasy-jackson"
cd openapi-swaggerui-quickstart
----

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/opentracing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=opentracing-quickstart \
-DclassName="org.acme.opentracing.TracedResource" \
-Dpath="/hello" \
-Dextensions="quarkus-smallrye-opentracing"
-Dextensions="resteasy,quarkus-smallrye-opentracing"
cd opentracing-quickstart
----

Expand Down
3 changes: 2 additions & 1 deletion docs/src/main/asciidoc/optaplanner.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ Alternatively, generate it from the command line with Maven:
mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectGroupId=org.acme \
-DprojectArtifactId=optaplanner-quickstart \
-Dextensions="resteasy,resteasy-jackson,optaplanner-quarkus,optaplanner-quarkus-jackson"
-Dextensions="resteasy,resteasy-jackson,optaplanner-quarkus,optaplanner-quarkus-jackson" \
-DnoExamples
cd optaplanner-quickstart
----
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/quartz.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectArtifactId=quartz-quickstart \
-DclassName="org.acme.quartz.TaskResource" \
-Dpath="/tasks" \
-Dextensions="quartz,hibernate-orm-panache,flyway,resteasy-jackson,jdbc-postgresql"
-Dextensions="resteasy,quartz,hibernate-orm-panache,flyway,resteasy-jackson,jdbc-postgresql"
cd quartz-quickstart
----

Expand Down
3 changes: 2 additions & 1 deletion docs/src/main/asciidoc/reactive-messaging-http.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ First, we need a new project. Create a new project with the following command:
mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
-DprojectGroupId=org.acme \
-DprojectArtifactId=reactive-messaging-http-quickstart \
-Dextensions="reactive-messaging-http"
-Dextensions="reactive-messaging-http" \
-DnoExamples
cd reactive-http
----

Expand Down
Loading

0 comments on commit 4db5743

Please sign in to comment.