This is an automated email from the ASF dual-hosted git repository.
ppalaga pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-quarkus.git
The following commit(s) were added to refs/heads/master by this push:
new 007304b Docs navigation improvements, docs wording
007304b is described below
commit 007304b78eaba32355e6c937139d05f32506189d
Author: Peter Palaga <[email protected]>
AuthorDate: Thu Apr 16 11:14:15 2020 +0200
Docs navigation improvements, docs wording
---
docs/modules/ROOT/nav.adoc | 3 +-
docs/modules/ROOT/pages/contributor-guide.adoc | 81 +---------------------
...ibutor-guide.adoc => create-new-extension.adoc} | 59 ++--------------
...-extensions.adoc => promote-jvm-to-native.adoc} | 11 +--
4 files changed, 18 insertions(+), 136 deletions(-)
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
index b3003df..4d2c445 100644
--- a/docs/modules/ROOT/nav.adoc
+++ b/docs/modules/ROOT/nav.adoc
@@ -4,5 +4,6 @@
** xref:native-mode.adoc[Native mode]
** xref:examples.adoc[Examples]
* xref:contributor-guide.adoc[Contributor guide]
-* xref:promote-jvm-only-extensions.adoc[Promote a JVM Only extension to native]
+** xref:create-new-extension.adoc[Create new extension].
+** xref:promote-jvm-to-native.adoc[Promote JVM extension to Native].
* xref:list-of-camel-quarkus-extensions.adoc[List of Camel Quarkus extensions]
diff --git a/docs/modules/ROOT/pages/contributor-guide.adoc
b/docs/modules/ROOT/pages/contributor-guide.adoc
index fd75add..a89ba50 100644
--- a/docs/modules/ROOT/pages/contributor-guide.adoc
+++ b/docs/modules/ROOT/pages/contributor-guide.adoc
@@ -45,82 +45,7 @@ A build with integration tests in both the JVM mode and the
native mode:
$ mvn clean install -Pnative
----
-[[create-a-new-extension]]
-== Create a new extension
+== What's next?
-1. You should know link:#how-to-build[how to build].
-
-2. Go through the https://quarkus.io/guides/extension-authors-guide[Quarkus
extension author's guide] to get an idea
- what is expecting you.
-
-3. Make sure that nobody else works on the same extension already by searching
through the
- https://github.com/apache/camel-quarkus/issues[GitHub issues].
-
-4. Let others know that you work on the given extension by either creating a
- https://github.com/apache/camel-quarkus/issues/new[new issue] or asking to
assign an existing one to you.
-
-5. Scaffold the necessary Maven modules using `quarkus-maven-plugin`. As an
example let's add a new extension for
- supporting an imaginary Camel component `foo-abc`:
-+
-[source,shell]
-----
-$ cd camel-quarkus
-$ mvn cq:create -N -Dcq.artifactIdBase=foo-abc
-----
-+
-where:
-+
-* `foo-abc` is the unique part of the new extension's `artifactId` without the
`camel-quarkus-` prefix
-+
-The above sequence of commands does the following:
-* It creates three new Maven modules under the `extensions` directory:
`camel-quarkus-foo-abc-parent`, `camel-quarkus-foo-abc`
- (a.k.a. the runtime module) and `camel-quarkus-foo-abc-deployment`.
-* These three modules are linked where necessary:
-** `camel-quarkus-foo-abc-parent` is added to the `<modules>` of
`camel-quarkus-extensions`
-** `camel-quarkus-foo-abc` is added to the `<dependencyManagement>` of the
runtime BOM (Bill of Materials) `poms/bom/pom.xml`
-** `camel-quarkus-foo-abc-deployment` is added to the `<dependencyManagement>`
of the deployment BOM (Bill of Materials) `poms/bom-deployment/pom.xml`
-* It creates a basic `FooAbcProcessor` class in the deployment module.
-* It also creates a stub of an integration test module under
`integration-tests/foo-abc`.
-+
-A compilation performed immediately after generating the modules should pass
flawlessly but running the tests will fail
-because the test project needs to get finished. You need to build `poms/bom`
and `poms/bom-deployment` one time first.
-
-6. Review the generated
-
`extensions/foo-abc/runtime/src/main/resources/META-INF/quarkus-extension.yaml`
file. If you
- see improper description or keyword,
- https://issues.apache.org/jira/secure/CreateIssue!default.jspa[file a new
Camel issue] and ask to fix the metadata
- for the given Camel component.
-7. Review the dependencies in the generate runtime and deployment modules. In
case the given library is supported by
- Quarkus, you may want to add a dependency on the corresponding Quarkus
extension.
-
-8. Complete the integration test module under `integration-tests/foo-abc`.
Make sure you test both the consumer and the
- producer of the component (if the component supports both). Make sure the
tests are passing both in the JVM mode
- (`mvn test`) and in the native mode (`mvn verify -Pnative`).
-
-9. In case of problems, consult the
https://quarkus.io/guides/extension-authors-guide[Quarkus extension author's
guide],
- ask for help in the given GitHub issue or via
https://gitter.im/apache/camel-quarkus[Camel Quarkus chat].
-
-10. If the usage of your new extension differs from the usage of the given
Camel component, please add an AsciiDoc page
- under `docs/modules/ROOT/pages/extensions` and document the differences and
Quarkus specific configuration options
- there. For our imaginary Camel component `foo-abc` the path of the page
would be
- `docs/modules/ROOT/pages/extensions/foo-abc.adoc`. After completing the
page, run `mvn clean install -DskipTests`
- from the root of the source tree to add your extension to the autogenerated
list of extensions.
-
-11. Before sending a pull request, please make sure you have run the following
Maven command from the project root folder:
-+
-[source,shell]
-----
-$ mvn process-resources -Pformat
-----
-+
-The above command will perform the following tasks:
-+
-* Add license headers to the new files
-* Re-generate the list of extensions and the Camel Quarkus Catalog
-* Sort elements in various POM files properly
-+
-Review the result visually.
-
-12. Please squash your commits before sending a pull request.
-
-Good luck!
+* xref:create-new-extension.adoc[Create new extension].
+* xref:promote-jvm-to-native.adoc[Promote a JVM extension to Native].
diff --git a/docs/modules/ROOT/pages/contributor-guide.adoc
b/docs/modules/ROOT/pages/create-new-extension.adoc
similarity index 72%
copy from docs/modules/ROOT/pages/contributor-guide.adoc
copy to docs/modules/ROOT/pages/create-new-extension.adoc
index fd75add..b28f620 100644
--- a/docs/modules/ROOT/pages/contributor-guide.adoc
+++ b/docs/modules/ROOT/pages/create-new-extension.adoc
@@ -1,57 +1,10 @@
-[[contributor-guide]]
-= Contributor guide
-
-[[prerequisites]]
-== Prerequisites
-
-* `git`
-* GraalVM with `native-image` command installed and `GRAALVM_HOME` environment
variable set, see
- https://quarkus.io/guides/building-native-image-guide[Building a native
executable] section of the Quarkus
- documentation.
-* If your are on Linux, `docker` is sufficient for the native mode too. Use
`-Pnative,docker` instead of `-Pnative`
- if you choose this option.
-* Java 8
-* Maven 3.6.2+ (unless you use the Maven Wrapper, a.k.a. `mvnw` available in
the source tree).
-
-[[how-to-build]]
-== How to build
-
-Checkout the code
-
-[source,shell]
-----
-$ git clone https://github.com/apache/camel-quarkus.git
-$ cd camel-quarkus
-----
-
-A fast build without tests:
-
-[source,shell]
-----
-$ mvn clean install -DskipTests
-----
-
-A build with integration tests in the JVM mode only:
-
-[source,shell]
-----
-$ mvn clean install
-----
-
-A build with integration tests in both the JVM mode and the native mode:
-
-[source,shell]
-----
-$ mvn clean install -Pnative
-----
-
[[create-a-new-extension]]
-== Create a new extension
+= Create a new extension
1. You should know link:#how-to-build[how to build].
-2. Go through the https://quarkus.io/guides/extension-authors-guide[Quarkus
extension author's guide] to get an idea
- what is expecting you.
+2. Go through the https://quarkus.io/guides/extension-authors-guide[Quarkus
extension author's guide] to get an idea of
+ what is expected from you.
3. Make sure that nobody else works on the same extension already by searching
through the
https://github.com/apache/camel-quarkus/issues[GitHub issues].
@@ -82,15 +35,15 @@ The above sequence of commands does the following:
* It creates a basic `FooAbcProcessor` class in the deployment module.
* It also creates a stub of an integration test module under
`integration-tests/foo-abc`.
+
-A compilation performed immediately after generating the modules should pass
flawlessly but running the tests will fail
+Compilation performed immediately after generating the modules should pass
flawlessly but running the tests will fail
because the test project needs to get finished. You need to build `poms/bom`
and `poms/bom-deployment` one time first.
6. Review the generated
`extensions/foo-abc/runtime/src/main/resources/META-INF/quarkus-extension.yaml`
file. If you
- see improper description or keyword,
+ see an improper description or keyword,
https://issues.apache.org/jira/secure/CreateIssue!default.jspa[file a new
Camel issue] and ask to fix the metadata
for the given Camel component.
-7. Review the dependencies in the generate runtime and deployment modules. In
case the given library is supported by
+7. Review the dependencies in the generated runtime and deployment modules. In
case the given library is supported by
Quarkus, you may want to add a dependency on the corresponding Quarkus
extension.
8. Complete the integration test module under `integration-tests/foo-abc`.
Make sure you test both the consumer and the
diff --git a/docs/modules/ROOT/pages/promote-jvm-only-extensions.adoc
b/docs/modules/ROOT/pages/promote-jvm-to-native.adoc
similarity index 87%
rename from docs/modules/ROOT/pages/promote-jvm-only-extensions.adoc
rename to docs/modules/ROOT/pages/promote-jvm-to-native.adoc
index 608edd6..610a560 100644
--- a/docs/modules/ROOT/pages/promote-jvm-only-extensions.adoc
+++ b/docs/modules/ROOT/pages/promote-jvm-to-native.adoc
@@ -1,7 +1,10 @@
-[[promote-jvm-only-extensions]]
-= Promote JVM Only extensions Native
+[[promote-jvm-to-native]]
+= Promote JVM extension to Native
-The directory `extensions-jvm` contains some extensions that need to be tested
in link:https://quarkus.io/guides/building-native-image[native mode].
Configuring the
link:https://quarkus.io/guides/writing-native-applications-tips[native build]
and implementing integration tests of such extensions may open the door to even
faster startup and lower footprint.
+The directory `extensions-jvm` contains extensions that have not been tested in
+link:https://quarkus.io/guides/building-native-image[native mode] yet.
Configuring the
+link:https://quarkus.io/guides/writing-native-applications-tips[native build]
and implementing integration tests for
+them may open the door to even faster startup and lower memory footprint.
Please find some guiding steps below to start this quest:
1. Make sure that nobody else works on promoting the same extension by
searching through the
@@ -120,4 +123,4 @@ mvn clean verify -P native
from runtime to build time. The
https://quarkus.io/guides/extension-authors-guide[Quarkus extension author's
guide] may be a good
ally for this.
-13. Please also check the
xref:contributor-guide.adoc#create-a-new-extension[Create a new extension]
section as it contains some useful tips for a good contribution.
+13. Please also check the xref:create-new-extension.adoc[Create new extension]
page as it contains some useful tips for a good contribution.
