[jira] [Commented] (CAMEL-24824) camel run --example: list the examples by group (quick-start first, then the ladder rungs, then showcase) and show what each teaches

["Claus Ibsen (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/CAMEL-24824?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18116877#comment-18116877 ] 

Claus Ibsen commented on CAMEL-24824:
-------------------------------------

Pull request: https://github.com/apache/camel/pull/26604 (covers CAMEL-24824 and CAMEL-24827).

> camel run --example: list the examples by group (quick-start first, then the ladder rungs, then showcase) and show what each teaches
> ------------------------------------------------------------------------------------------------------------------------------------
>
>                 Key: CAMEL-24824
>                 URL: https://issues.apache.org/jira/browse/CAMEL-24824
>             Project: Camel
>          Issue Type: Improvement
>          Components: camel-jbang
>            Reporter: Claus Ibsen
>            Assignee: Claus Ibsen
>            Priority: Major
>             Fix For: 4.23.0
>
>
> camel-jbang-examples is now organised as a ladder (CAMEL-24808): the directories are quick-start, run, transform, route, fail-well, connect, connect-service, contracts, ai, cloud and showcase, each example's metadata.json has *level* set to its group, a *teaches* block (components, EIPs, languages, data formats), *infraServices* for the service it needs, and *ciSkip* for the tests that need a model. The root README renders the same groups as tables from the catalog.
> *camel run --example* (with no name it lists the available examples) and the example tools of the MCP server still show a flat list. Proposal:
> # group the listing by level in ladder order, quick-start first, showcase last, with the one-line group introduction the README uses;
> # show the *teaches* summary and *infraServices* next to each example, so a user (or a model) can pick by component or EIP and see which examples need Docker or a model;
> # let *camel run --example <name>* accept the group-qualified name (route/aggregator) as well as the short one (aggregator), and resolve an ambiguous short name with a hint;
> # read *ciSkip* so the listing can mark the examples that are run by hand.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)