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
Tidy up kamelets docs and remove knative binding #1705
Comments
The main problem is understanding if we can move away from the js generation for the docs example. Because actually we're using that stuff with a template. |
I would like to restart the discussion on this but we need some help from @zregvart Do you think is feasible to go away from js generation on-the-fly and have generated .adoc directly in the repository? That way we could focus on improving one/two Kamelets and see how it goes and go through all of them later. Working on the js side of thing keep things harder. |
It is very much feasible, this is what we do in the Camel components documentation. This can be done in a separate Antora module and later on rename that module to the
I think, this can be done today without changing the template processing, by placing a
To the With that said, rendering the templates and having plain asciidoc files in the |
Do you have eventually time to draft something we could start to hack on? Like a branch with just one adoc ported? Thanks. |
Unfortunately, I don't see much free time to work on this in the near term; perhaps I can find some time in a month or two... |
I tried to add this file https://github.com/apache/camel-kamelets/blob/main/docs/modules/ROOT/pages/aws-s3-source-description.adoc And add the include in the template in the template kamelet-options But it doesn't render yet on the website https://camel.apache.org/camel-kamelets/next/aws-s3-source.html @zregvart can you help on this? |
Yeah I fixed that but forget to update here |
Ok, but the problem is it needs to be included in https://camel.apache.org/camel-kamelets/next/aws-s3-source.html Now I should be able to include it, but I'll have to use the correct level because the website fails with
|
If you include an |
But then I'll have to do something like
and it won't resolve the name part. |
This c31b25a should fix that |
@davsclaus @zregvart this is working now and here is how it looks like: https://camel.apache.org/camel-kamelets/next/aws-s3-source.html So it will be enough to create a file named <kamelet_name>-description.adoc in partials folder and we could enrich the documentation and maintain the autogenerated part. So we could start improving the most prominent kamelets. |
Kamelets are universal connectors for Camel, and we should tidy up docs and make it more user focused and less tech savy.
The knative binding stuff should be removed. This kind of docs belong in camel-k knative section.
Also it would be good later to go over kamelets and add more description what they do, and some small examples, also for the options.
The text was updated successfully, but these errors were encountered: