Skip to content

CAMEL-23789: Improve camel-kafka docs with multi-DSL tabs#24096

Open
davsclaus wants to merge 1 commit into
mainfrom
feature/CAMEL-23789-kafka-multi-dsl-docs
Open

CAMEL-23789: Improve camel-kafka docs with multi-DSL tabs#24096
davsclaus wants to merge 1 commit into
mainfrom
feature/CAMEL-23789-kafka-multi-dsl-docs

Conversation

@davsclaus

Copy link
Copy Markdown
Contributor

Summary

Claude Code on behalf of Claus Ibsen

Improves the camel-kafka component documentation to be multi-DSL friendly, as part of CAMEL-23789.

  • Added XML/YAML tabs to 12 route examples that were previously Java-only (header deserializer/serializer, header filter strategy, JMS interop, producing messages, OAuth auth, SSL config, offset management, producer performance aggregate, idempotent repository, SSLContextParameters)
  • Resolved Java constants to string values in code examples (KafkaConstants.KEY"CamelKafkaKey", KafkaConstants.MANUAL_COMMIT"CamelKafkaManualCommit", KafkaTestUtil.MOCK_RESULT"mock:result") with TIP notes pointing to the Java constant
  • Removed string concatenation and fromF() patterns, replacing with plain URIs
  • Extracted routes from RouteBuilder wrappers (offset management, SSL via SSLContextParameters)
  • Added _Java-only: markers (18 total) to inherently Java examples (lambda processors, programmatic component config, custom classes)
  • Added configuration property alternatives alongside programmatic Java component configuration (breakOnFirstError, manual commit, shutdown timeout, Kerberos)

Before / After

Metric Before After
Tabs blocks 6 18
Java-only markers 0 18
Unresolved Java constants in code 5 0
String concatenation in examples 3 0

Test plan

  • Verify the AsciiDoc renders correctly (tabs blocks balanced, markers display properly)
  • Verify XML examples use & for query parameter separators
  • Verify YAML examples use proper indentation and parameter structure

🤖 Generated with Claude Code

…ly markers

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@github-actions

Copy link
Copy Markdown
Contributor

🌟 Thank you for your contribution to the Apache Camel project! 🌟
🤖 CI automation will test this PR automatically.

🐫 Apache Camel Committers, please review the following items:

  • First-time contributors require MANUAL approval for the GitHub Actions to run
  • You can use the command /component-test (camel-)component-name1 (camel-)component-name2.. to request a test from the test bot although they are normally detected and executed by CI.
  • You can label PRs using skip-tests and test-dependents to fine-tune the checks executed by this PR.
  • Build and test logs are available in the summary page. Only Apache Camel committers have access to the summary.

⚠️ Be careful when sharing logs. Review their contents before sharing them publicly.

@github-actions

Copy link
Copy Markdown
Contributor

🧪 CI tested the following changed modules:

  • components/camel-kafka

⚠️ Some tests are disabled on GitHub Actions (@DisabledIfSystemProperty(named = "ci.env.name")) and require manual verification:

  • components/camel-kafka: 2 test(s) disabled on GitHub Actions
All tested modules (8 modules)
  • Camel :: JBang :: MCP
  • Camel :: JBang :: Plugin :: Route Parser
  • Camel :: JBang :: Plugin :: TUI
  • Camel :: JBang :: Plugin :: Validate
  • Camel :: Kafka
  • Camel :: Launcher :: Container
  • Camel :: YAML DSL :: Validator
  • Camel :: YAML DSL :: Validator Maven Plugin

⚙️ View full build and test results

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants