Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove prefix from shell code snippets #6262

Merged
merged 1 commit into from
Jul 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ for the following:
+
[source,shell]
----
$ cd camel-quarkus
$ mvn cq:create -N -Dcq.artifactIdBase=foo-abc -Dcq.nativeSupported=false
cd camel-quarkus
mvn cq:create -N -Dcq.artifactIdBase=foo-abc -Dcq.nativeSupported=false
----
+
* A basic integration test is generated for you. It just checks that the newly added Camel component can be loaded.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ This guide outlines how to contribute a new example project to https://github.co
+
[source,shell]
----
$ cd camel-quarkus-examples
$ mvn org.l2x6.cq:cq-maven-plugin:create-example -Dcq.artifactIdBase="yaml-to-log" -Dcq.exampleName="YAML To Log" -Dcq.exampleDescription="Shows how to use a YAML route with the log EIP"
cd camel-quarkus-examples
mvn org.l2x6.cq:cq-maven-plugin:create-example -Dcq.artifactIdBase="yaml-to-log" -Dcq.exampleName="YAML To Log" -Dcq.exampleDescription="Shows how to use a YAML route with the log EIP"
----
+
Where:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
+
[source,shell]
----
$ cd camel-quarkus
$ mvn cq:create -N -Dcq.artifactIdBase=foo-abc
cd camel-quarkus
mvn cq:create -N -Dcq.artifactIdBase=foo-abc
----
+
where:
Expand Down Expand Up @@ -80,7 +80,7 @@ Check the xref:contributor-guide/extension-metadata.adoc[Extension metadata] pag
+
[source,shell]
----
$ mvn process-resources -Pformat
mvn process-resources -Pformat
----
+
The above command will perform the following tasks:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ the source tree:

[source,shell]
----
$ mvn -N cq:update-quarkus-metadata
mvn -N cq:update-quarkus-metadata
----

The data comes from the following
Expand Down
10 changes: 5 additions & 5 deletions docs/modules/ROOT/pages/contributor-guide/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,29 +21,29 @@ Checkout the code

[source,shell]
----
$ git clone https://github.com/apache/camel-quarkus.git
$ cd camel-quarkus
git clone https://github.com/apache/camel-quarkus.git
cd camel-quarkus
----

A fast build without tests and various checks:

[source,shell]
----
$ mvn clean install -Dquickly
mvn clean install -Dquickly
----

A build with integration tests in the JVM mode only:

[source,shell]
----
$ mvn clean install
mvn clean install
----

A build with integration tests in both the JVM mode and the native mode:

[source,shell]
----
$ mvn clean install -Pnative
mvn clean install -Pnative
----

TIP: You may want to install and use https://github.com/mvndaemon/mvnd[`mvnd` - the Maven Daemon] for faster builds.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Please find some guiding steps below to start this quest:
+
[source,shell]
----
$ cd camel-quarkus
$ mvn -N cq:promote -Dcq.artifactIdBase=...
cd camel-quarkus
mvn -N cq:promote -Dcq.artifactIdBase=...
----
+
where `cq.artifactIdBase` needs to be set to the unique part of the `artifactId` of the extension you are
Expand All @@ -42,8 +42,8 @@ The `promote` mojo does the following for you:
+
[source,shell]
----
$ cd integration-tests/foo
$ mvn clean verify -Pnative
cd integration-tests/foo
mvn clean verify -Pnative
----
+
Consider shifting some tasks from runtime to build time.
Expand All @@ -53,7 +53,7 @@ The https://quarkus.io/guides/extension-authors-guide[Quarkus extension author's
+
[source,shell]
----
$ mvn clean install -DskipTests -Pformat
mvn clean install -DskipTests -Pformat
----

7. Squash your commits before sending a pull request.
Expand Down
Loading