Skip to content

[backport camel-latest] docs: update website for merged PRs - #481

Merged
Croway merged 1 commit into
KaotoIO:camel-latestfrom
Croway:backport/docs-to-camel-latest
Jul 16, 2026
Merged

[backport camel-latest] docs: update website for merged PRs#481
Croway merged 1 commit into
KaotoIO:camel-latestfrom
Croway:backport/docs-to-camel-latest

Conversation

@Croway

@Croway Croway commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Backport of #480

Cherry-pick of #480 onto camel-latest.

Original PR: #480 - docs: update website for merged PRs (#406, #407, #408, #409, #410, #433, #436)
Original author: @Croway
Target branch: camel-latest

Changes

Same as #480 — adds TLS module docs, migration guide, per-broker JMS docs, guardrails opt-in, troubleshooting entries, and updates across 13 files.

One conflict resolved in website/docs/modules/jms.md (camel-latest didn't have the XA Transactions section — incoming content kept in full).

Test plan

  • mkdocs build passes with no errors on camel-latest

Summary by CodeRabbit

  • Documentation
    • Added TLS configuration guidance, including keystore/truststore setup, named profiles, and Camel route usage.
    • Expanded JMS documentation for named brokers, prefixed routes, and mixed XA/non-XA transactions.
    • Added troubleshooting guidance for unknown providers, RAG assembly, and guardrail failures.
    • Clarified AI agent guardrails, provider selection, multimodal content, memory isolation, and fail-fast behavior.
    • Expanded vector database provider notes and RAG configuration examples.
    • Improved configuration, migration, JDBC, and navigation documentation.

@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b281f719-1ed1-4ac4-83ea-917105748735

📥 Commits

Reviewing files that changed from the base of the PR and between 31dfbd8 and c9b4bda.

📒 Files selected for processing (13)
  • website/docs/concepts/configuration.md
  • website/docs/examples/ai/multi-agent.md
  • website/docs/examples/ai/rag.md
  • website/docs/guides/migration.md
  • website/docs/guides/troubleshooting.md
  • website/docs/modules/ai/agents.md
  • website/docs/modules/ai/chat-memory.md
  • website/docs/modules/ai/vector-databases.md
  • website/docs/modules/index.md
  • website/docs/modules/jdbc.md
  • website/docs/modules/jms.md
  • website/docs/modules/security/tls.md
  • website/mkdocs.yml

📝 Walkthrough

Walkthrough

This PR updates Forage's documentation across configuration examples, migration and troubleshooting guides, AI module docs (agents, chat-memory, vector-databases, multi-agent, rag), and JMS per-broker/XA docs, and adds a new TLS security module page with corresponding modules index and mkdocs navigation entries.

Changes

Documentation updates

Layer / File(s) Summary
Configuration examples: TLS properties and named broker routes
website/docs/concepts/configuration.md
Adds a TLS properties file to the split-config example and switches the broker route example to a prefixed URI syntax plus a TLS profiles snippet.
New TLS module documentation and navigation
website/docs/modules/security/tls.md, website/docs/modules/index.md, website/mkdocs.yml
Adds a new TLS page covering SSLContextParameters configuration and links it from the modules index and mkdocs navigation.
JMS per-broker components and mixed XA docs
website/docs/modules/jms.md
Documents per-broker prefixed JmsComponent usage and mixed XA/non-XA broker transaction scoping.
AI module docs: guardrails, memory isolation, provider selection, RAG/vector stores
website/docs/modules/ai/agents.md, website/docs/modules/ai/chat-memory.md, website/docs/modules/ai/vector-databases.md, website/docs/examples/ai/multi-agent.md, website/docs/examples/ai/rag.md
Expands guardrails, memory isolation, provider selection, and vector database provider notes; adds key takeaways on deterministic provider selection and RAG fail-fast behavior.
Migration heading restructuring and troubleshooting scenarios
website/docs/guides/migration.md, website/docs/guides/troubleshooting.md, website/docs/modules/jdbc.md
Downgrades migration guide heading levels and revises intro; adds new troubleshooting entries and a jdbc.md info note on unrecognized db.kind.

Estimated code review effort: 1 (Trivial) | ~10 minutes

Possibly related PRs

  • KaotoIO/forage#263: Builds on the same documentation infrastructure, updating related docs pages and adding new sections like security/tls.md.
  • KaotoIO/forage#478: Corresponds to the per-broker JmsComponent registration and JTA transaction scoping documented in this PR's JMS updates.
  • KaotoIO/forage#479: Matches the per-broker JMS component registration with broker-specific JtaTransactionManager wiring documented here.

Suggested reviewers: orpiske

Poem

A hop through docs, both new and old,
TLS pages shine, secure and bold,
Brokers now wear their prefix proud,
Guardrails whisper safety aloud,
This bunny thumps in pure delight—
Docs polished, clear, and just right! 🐰📚

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

…O#408, KaotoIO#409, KaotoIO#410, KaotoIO#433, KaotoIO#436)

- Add forage-security-tls module page with properties, named profiles, and usage examples
- Add version migration section covering breaking changes (guardrails opt-in, removed config entries, default model names, fail-fast behavior)
- Document per-broker JMS component pattern and mixed XA/non-XA setup
- Add guardrails explicit opt-in section, memory isolation, multimodal support, and provider selection to agents docs
- Expand vector databases page with per-provider notes
- Add fail-fast error entries to troubleshooting guide
- Update JDBC, RAG, multi-agent, chat-memory, and configuration docs
@Croway
Croway force-pushed the backport/docs-to-camel-latest branch from 23bb30d to c9b4bda Compare July 16, 2026 13:51
@Croway
Croway merged commit cbb49c1 into KaotoIO:camel-latest Jul 16, 2026
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant