Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve routing examples java and xml context DSL in documentation #1001

Open
darkmastermindz opened this issue May 12, 2023 · 5 comments
Open
Labels
help wanted Extra attention is needed

Comments

@darkmastermindz
Copy link

Would like to request addition of equivalent side by side code example documentation for all the examples where XML and Java DSL can help the user translate between the two.

@davsclaus
Copy link
Contributor

You are welcome to send PRs and help update the documentation

@darkmastermindz
Copy link
Author

darkmastermindz commented May 15, 2023

@davsclaus where are the Java / XML DSL snippets examples located for camel components, could you provide an example to this? Would like to help with support to older versions of the docs as well, but have a hard time finding these equivalent docs pages in the repo: https://camel.apache.org/components/3.20.x/index.html

@davsclaus
Copy link
Contributor

the examples are in the doc pages directly so some component have some examples but not every component. And often the examples are either Java or XML.

To build examples for everything and also for Java, XML and YAML is a lot of work.

@davsclaus
Copy link
Contributor

I would focus on docs on main branch, then we can backport if needed, but future development is on Camel v4, and v3 is slowing down.

@darkmastermindz
Copy link
Author

@davsclaus This definitely might take a while any help from the community is appreciated as well if you could mark this as "help wanted." I just would like to provide better documentation for a better experience to more junior developers who are using camel routes with providing proper documentation between the different DSLs starting with Java / XML which is the most common for spring boot camel apps. Another thing I found that might help is using a hawtio to help with some of the documentation translations.

@davsclaus davsclaus added the help wanted Extra attention is needed label May 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants