Update non-working examples in Kamelet Catalog docs #897
Conversation
|
I would like a review about this approach, if everything is ok, I can work to fix the remaining non working kamelet binding examples. |
Fix apache#866 * There are some generated kamelet bindings are invalid, the auto generation cannot resolve all the required steps, so there is a need to create it manually * Add a comment marker in kamelet binding examples for the auto generation to skip its creation * The doc generation source the kamelet binding example file when it doesn't auto generate the example * the camel-kamelets directory is hardcoded in kamelets.js as it is assumed this generation mechanism already assumes this directory
|
Thanks |
| @@ -16,6 +16,8 @@ | |||
| */ | |||
|
|
|||
| const util = require('camel-website-util') | |||
| const fs = require('fs') | |||
| const yaml = require('js-yaml'); | |||
There was a problem hiding this comment.
If you're importing here you also need to adjust package.json in camel-website, i.e. add js-yaml to devDependencies. You also need to make sure that the js-yaml is placed in the PnP cache. Or avoid using js-yaml or any non-managed dependency.
I can see the net positive of having them versioned within the module. But I don't see a way for them to be tested, debugged or linted here. So until this is figured out I can't recommend doing this here.
There was a problem hiding this comment.
Do we have to revert? The website build is stuck
There was a problem hiding this comment.
Ops, I will push the js-yaml dependency change to camel-website. Just forgot it.
Fix #866
generation cannot resolve all the required steps, so there is
a need to create it manually
generation to skip its creation
doesn't auto generate the example
assumed this generation mechanism already assumes this directory