This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch feature/CAMEL-23722-cli-docs-restructure in repository https://gitbox.apache.org/repos/asf/camel.git
commit 41f0b55419dce32dba131bdbc81efa7d6bab1dab Author: Claus Ibsen <[email protected]> AuthorDate: Tue Jun 9 20:29:26 2026 +0200 CAMEL-23722: Move catalog to Getting Started, rename page to Export to Maven Co-Authored-By: Claude <[email protected]> Signed-off-by: Claus Ibsen <[email protected]> --- docs/user-manual/modules/ROOT/nav.adoc | 2 +- .../ROOT/pages/camel-jbang-getting-started.adoc | 53 +++++++++++++++++++++- .../modules/ROOT/pages/camel-jbang-projects.adoc | 53 +--------------------- .../modules/ROOT/pages/camel-jbang.adoc | 4 +- 4 files changed, 56 insertions(+), 56 deletions(-) diff --git a/docs/user-manual/modules/ROOT/nav.adoc b/docs/user-manual/modules/ROOT/nav.adoc index fd117061334f..55d0b2d55b28 100644 --- a/docs/user-manual/modules/ROOT/nav.adoc +++ b/docs/user-manual/modules/ROOT/nav.adoc @@ -15,7 +15,7 @@ *** xref:camel-jbang-debugging.adoc[Debugging] *** xref:camel-jbang-transforming.adoc[Data Transformation] *** xref:camel-jbang-managing.adoc[Managing Integrations] -*** xref:camel-jbang-projects.adoc[Projects and Catalog] +*** xref:camel-jbang-projects.adoc[Export to Maven] *** xref:camel-jbang-tips.adoc[Tips and Recipes] *** xref:camel-jbang-configuration.adoc[Configuration] *** xref:jbang-commands/camel-jbang-commands.adoc[Command Reference] diff --git a/docs/user-manual/modules/ROOT/pages/camel-jbang-getting-started.adoc b/docs/user-manual/modules/ROOT/pages/camel-jbang-getting-started.adoc index cdc8f2a3d1c8..57d780a2f1af 100644 --- a/docs/user-manual/modules/ROOT/pages/camel-jbang-getting-started.adoc +++ b/docs/user-manual/modules/ROOT/pages/camel-jbang-getting-started.adoc @@ -124,6 +124,55 @@ camel run * TIP: The CLI automatically picks up `application.properties` files in the same directory. +== Browse the component catalog + +Discover what Camel offers — components, data formats, languages, and Kamelets: + +[source,bash] +---- +camel catalog component +camel catalog kamelet +---- + +TIP: Run `camel catalog --help` to see all sub-commands. + +=== Component documentation + +Show quick reference documentation (description + all configuration options): + +[source,bash] +---- +camel doc kafka +camel doc jackson +camel doc aws-kinesis-sink +---- + +NOTE: This shows catalog-level documentation with option tables, not the full website documentation. + +If a component and data format share the same name, prefix with `dataformat:` (e.g., `camel doc dataformat:thrift`). + +Open the online documentation in a browser with `--open-url`, or get just the URL with `--url`: + +[source,bash] +---- +camel doc kafka --open-url +---- + +Filter options by name, description, or group (producer, security, advanced, etc.): + +[source,bash] +---- +camel doc kafka --filter=security +camel doc kafka --filter=timeout +---- + +=== Open API + +Camel CLI supports contract-first REST development — each OpenAPI operation is bridged to +a Camel route via `direct:<operationId>`. + +See the https://github.com/apache/camel-kamelets-examples/tree/main/jbang/open-api[open-api example] for details. + == Enable shell completion Tab completion makes discovering commands much easier: @@ -170,6 +219,6 @@ For the full list of commands, see the xref:jbang-commands/camel-jbang-commands. | xref:camel-jbang-debugging.adoc[Debugging] | Step through routes with the built-in debugger or connect your IDE. -| xref:camel-jbang-projects.adoc[Projects and Catalog] -| Browse the component catalog, export to Spring Boot or Quarkus for production. +| xref:camel-jbang-projects.adoc[Export to Maven] +| Export to Spring Boot, Quarkus, or Camel Main for production. Manage dependencies and versions. |=== diff --git a/docs/user-manual/modules/ROOT/pages/camel-jbang-projects.adoc b/docs/user-manual/modules/ROOT/pages/camel-jbang-projects.adoc index 524b9a5ea4db..45ab6dafe059 100644 --- a/docs/user-manual/modules/ROOT/pages/camel-jbang-projects.adoc +++ b/docs/user-manual/modules/ROOT/pages/camel-jbang-projects.adoc @@ -1,55 +1,6 @@ -= Camel CLI - Projects and Catalog += Camel CLI - Export to Maven -The Camel CLI helps you manage the full project lifecycle — from exploring the component catalog and managing dependencies to exporting production-ready projects and upgrading Camel versions. - -== Component catalog - -Browse the Camel catalog — components, data formats, languages, and Kamelets: - -[source,bash] ----- -camel catalog component -camel catalog kamelet ----- - -TIP: Run `camel catalog --help` to see all sub-commands. - -=== Component documentation - -Show quick reference documentation (description + all configuration options): - -[source,bash] ----- -camel doc kafka -camel doc jackson -camel doc aws-kinesis-sink ----- - -NOTE: This shows catalog-level documentation with option tables, not the full website documentation. - -If a component and data format share the same name, prefix with `dataformat:` (e.g., `camel doc dataformat:thrift`). - -Open the online documentation in a browser with `--open-url`, or get just the URL with `--url`: - -[source,bash] ----- -camel doc kafka --open-url ----- - -Filter options by name, description, or group (producer, security, advanced, etc.): - -[source,bash] ----- -camel doc kafka --filter=security -camel doc kafka --filter=timeout ----- - -== Open API - -Camel CLI supports contract-first REST development — each OpenAPI operation is bridged to -a Camel route via `direct:<operationId>`. - -See the https://github.com/apache/camel-kamelets-examples/tree/main/jbang/open-api[open-api example] for details. +Export your Camel CLI integrations to production-ready Maven projects, manage dependencies, and upgrade Camel versions. == Creating Projects diff --git a/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc b/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc index 127e0ff0f21a..ae2e253273a6 100644 --- a/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc +++ b/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc @@ -105,8 +105,8 @@ TIP: You can also install without JBang using the xref:camel-jbang-launcher.adoc | Listing and stopping processes, route and group control, developer console, message history, log tailing, message tracing, health checks, metrics, circuit breaker status, Jolokia and Hawtio. -| xref:camel-jbang-projects.adoc[Projects and Catalog] -| Component catalog, exporting to Spring Boot / Quarkus / Camel Main, +| xref:camel-jbang-projects.adoc[Export to Maven] +| Exporting to Spring Boot / Quarkus / Camel Main, SBOM generation, plugin management, version management, automated upgrades. | xref:camel-jbang-tips.adoc[Tips and Recipes]
