Federico Mariani created CAMEL-26346:
----------------------------------------
Summary: camel-jbang - Document CLI release selection (latest vs
LTS), pinning and community plugin compatibility
Key: CAMEL-26346
URL: https://issues.apache.org/jira/browse/CAMEL-26346
Project: Camel
Issue Type: Task
Components: documentation, camel-jbang
Reporter: Federico Mariani
h3. Problem
The quick start installs the latest Camel CLI release without explaining that
it can be newer than the latest LTS, or than the versions community plugins
support. Exact-version installation is documented elsewhere, but users can miss
it. Today:
* the default installer selects 4.23.0
* the latest LTS is 4.22.2
* the newest Forage release (1.6.2) is built for 4.22
So a default CLI install followed by {{camel plugin add forage}} produces a
combination that fails on {{camel run}}.
h3. Acceptance criteria
* Add a note below the quick-start installer command saying that the default
installs the latest release.
* Show an exact LTS install example ({{--version 4.22.2}}), linking to
Downloads for the current LTS patch, followed by {{camel version}}.
* Explain pinning: {{--version}} writes a pin that {{camel self-update}}
respects. Explain how to move to a newer patch deliberately.
* Cover the web launcher, JBang and Windows installation paths consistently.
* Distinguish the installed CLI version from runtime dependency selection
({{--camel-version}}, {{camel version set}}).
* Explain that community plugins are built for specific Camel lines, and show
explicit selection with {{camel plugin add <name> --version X}}.
* For the 4.18 LTS, document {{camel plugin add forage --gav
io.kaoto.forage:camel-jbang-plugin-forage:1.4.x}}. The known-plugin catalog
(CAMEL-23491) first shipped in 4.21.0, so {{--version}} does not work for
Forage on 4.18.
* Link the installation, export and plugin pages instead of duplicating a
compatibility matrix.
* Document the {{LTS}} / {{X.Y}} selectors once CAMEL-26345 ships, and
automatic plugin selection once CAMEL-26344 ships.
Relevant files: {{docs/user-manual/modules/ROOT/pages/camel-jbang.adoc}},
{{camel-jbang-launcher-install.adoc}}, {{camel-jbang-installation.adoc}},
{{camel-jbang-projects.adoc}}.
--
This message was sent by Atlassian Jira
(v10.3.26#10030026)
