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

(#5489) Groovy > Yaml #5497

Merged
merged 3 commits into from
May 16, 2024
Merged

(#5489) Groovy > Yaml #5497

merged 3 commits into from
May 16, 2024

Conversation

tdiesler
Copy link
Contributor

There will be so many changes ... so perhaps we do this incrementally

Copy link
Contributor

@squakez squakez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. However we must not add any file example here directly. For those we have the https://github.com/apache/camel-k-examples/tree/main/generic-examples

All along the documentation we just need to replace the snippets with the yaml DSL, that should be enough. And yes, feel free to open separate PR and do it iteratively if you prefer.

@tdiesler
Copy link
Contributor Author

tdiesler commented May 10, 2024

Do you know what this is ...
https://github.com/apache/camel-k/tree/main/docs/modules/ROOT/examples/js

$ git grep ck.js                                    
docs/antora.yml:    requires: "'util=camel-website-util,ck=xref:js/ck.js'"

@squakez
Copy link
Contributor

squakez commented May 13, 2024

Do you know what this is ... https://github.com/apache/camel-k/tree/main/docs/modules/ROOT/examples/js

$ git grep ck.js                                    
docs/antora.yml:    requires: "'util=camel-website-util,ck=xref:js/ck.js'"

No, unfortunately not. We have some configuration magic that I am not familiar with. Mind that certain configuration are required by the main Camel project which is in charge to include the subproject (hence, Camel K among others) bits.


```yaml
- from:
uri: "timer:yaml"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd leave the timer:tick instead. Any newcomer may confuse the name of the component with the DSL.

@tdiesler tdiesler force-pushed the ghi5489 branch 2 times, most recently from 75d792c to b36622a Compare May 14, 2024 08:16
Copy link
Contributor

@squakez squakez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor changes, the rest is good, thanks!

@tdiesler tdiesler changed the title (#5489) Docs index - how it works (#5489) Groovy > Yaml May 14, 2024
Copy link
Contributor

⚠️ Unit test coverage report - coverage decreased from 38.2% to 38.1% (-0.1%)

@tdiesler tdiesler force-pushed the ghi5489 branch 4 times, most recently from 28321b3 to 2961aa0 Compare May 15, 2024 11:37
@tdiesler
Copy link
Contributor Author

All docs should be done - ready to merge

@oscerd
Copy link
Contributor

oscerd commented May 15, 2024

If we merge, let's run the ci-build for website here: https://ci-builds.apache.org/job/Camel/job/Camel.website/job/main/

in case something is broken we need to fix it soon or revert.

@tdiesler
Copy link
Contributor Author

$ ./docs/local-build.sh quick
[15:31:01.130] INFO (@djencks/antora-timer): stage playbookBuilt took 0.167s
[15:31:01.132] INFO (@djencks/antora-timer): Extensions after stage playbookBuilt took 0.002s
[15:31:01.135] INFO (@djencks/antora-timer): stage beforeProcess took 0.003s
[15:31:01.136] INFO (@djencks/antora-timer): Extensions after stage beforeProcess took 0.001s
[15:31:01.229] INFO (@djencks/antora-timer): stage uiLoaded took 0.093s
[15:31:01.229] INFO (@djencks/antora-timer): Extensions after stage uiLoaded took 0s
[15:31:01.258] INFO (@djencks/antora-timer): stage contentAggregated took 0.029s
[15:31:01.259] INFO (@djencks/antora-timer): Extensions after stage contentAggregated took 0.001s
[15:31:01.262] INFO (@djencks/antora-timer): stage contentClassified took 0.003s
[15:31:01.289] INFO (@djencks/antora-timer): Extensions after stage contentClassified took 0.027s
[15:31:02.842] INFO (@djencks/antora-timer): stage documentsConverted took 1.553s
[15:31:02.842] INFO (@djencks/antora-timer): Extensions after stage documentsConverted took 0s
[15:31:02.849] INFO (@djencks/antora-timer): stage navigationBuilt took 0.007s
[15:31:02.849] INFO (@djencks/antora-timer): Extensions after stage navigationBuilt took 0s
[15:31:03.049] INFO (@djencks/antora-timer): stage pagesComposed took 0.2s
[15:31:03.049] INFO (@djencks/antora-timer): Extensions after stage pagesComposed took 0s
[15:31:03.050] INFO (@djencks/antora-timer): stage redirectsProduced took 0.001s
[15:31:03.050] INFO (@djencks/antora-timer): Extensions after stage redirectsProduced took 0s
[15:31:03.052] INFO (@djencks/antora-timer): stage siteMapped took 0.002s
[15:31:03.052] INFO (@djencks/antora-timer): Extensions after stage siteMapped took 0s
[15:31:03.052] INFO (@djencks/antora-timer): stage beforePublish took 0s
[15:31:03.052] INFO (@djencks/antora-timer): Extensions after stage beforePublish took 0s
Site generation complete!
Open file:///Users/tdiesler/git/camel-website/documentation in a browser to view your site.
[15:31:03.133] INFO (@djencks/antora-timer): stage sitePublished took 0.081s
[15:31:03.133] INFO (@djencks/antora-timer): stage sitePublished took 0s
[15:31:03.133] INFO (@djencks/antora-timer): total build time 2.17s

@oscerd
Copy link
Contributor

oscerd commented May 15, 2024

$ ./docs/local-build.sh quick
[15:31:01.130] INFO (@djencks/antora-timer): stage playbookBuilt took 0.167s
[15:31:01.132] INFO (@djencks/antora-timer): Extensions after stage playbookBuilt took 0.002s
[15:31:01.135] INFO (@djencks/antora-timer): stage beforeProcess took 0.003s
[15:31:01.136] INFO (@djencks/antora-timer): Extensions after stage beforeProcess took 0.001s
[15:31:01.229] INFO (@djencks/antora-timer): stage uiLoaded took 0.093s
[15:31:01.229] INFO (@djencks/antora-timer): Extensions after stage uiLoaded took 0s
[15:31:01.258] INFO (@djencks/antora-timer): stage contentAggregated took 0.029s
[15:31:01.259] INFO (@djencks/antora-timer): Extensions after stage contentAggregated took 0.001s
[15:31:01.262] INFO (@djencks/antora-timer): stage contentClassified took 0.003s
[15:31:01.289] INFO (@djencks/antora-timer): Extensions after stage contentClassified took 0.027s
[15:31:02.842] INFO (@djencks/antora-timer): stage documentsConverted took 1.553s
[15:31:02.842] INFO (@djencks/antora-timer): Extensions after stage documentsConverted took 0s
[15:31:02.849] INFO (@djencks/antora-timer): stage navigationBuilt took 0.007s
[15:31:02.849] INFO (@djencks/antora-timer): Extensions after stage navigationBuilt took 0s
[15:31:03.049] INFO (@djencks/antora-timer): stage pagesComposed took 0.2s
[15:31:03.049] INFO (@djencks/antora-timer): Extensions after stage pagesComposed took 0s
[15:31:03.050] INFO (@djencks/antora-timer): stage redirectsProduced took 0.001s
[15:31:03.050] INFO (@djencks/antora-timer): Extensions after stage redirectsProduced took 0s
[15:31:03.052] INFO (@djencks/antora-timer): stage siteMapped took 0.002s
[15:31:03.052] INFO (@djencks/antora-timer): Extensions after stage siteMapped took 0s
[15:31:03.052] INFO (@djencks/antora-timer): stage beforePublish took 0s
[15:31:03.052] INFO (@djencks/antora-timer): Extensions after stage beforePublish took 0s
Site generation complete!
Open file:///Users/tdiesler/git/camel-website/documentation in a browser to view your site.
[15:31:03.133] INFO (@djencks/antora-timer): stage sitePublished took 0.081s
[15:31:03.133] INFO (@djencks/antora-timer): stage sitePublished took 0s
[15:31:03.133] INFO (@djencks/antora-timer): total build time 2.17s

This is good, but the full build from the website on the CI might fail anyway. It happened before. But this is great! Thanks @tdiesler

@tdiesler
Copy link
Contributor Author

Could we run this again pls?

@tdiesler
Copy link
Contributor Author

Ready to merge

@oscerd oscerd merged commit a09a41c into apache:main May 16, 2024
13 checks passed
@oscerd
Copy link
Contributor

oscerd commented May 16, 2024

@tdiesler tdiesler deleted the ghi5489 branch May 16, 2024 07:44
@tdiesler
Copy link
Contributor Author

Thanks @oscerd - the msg for the squashed commit is a little awkward
As you might recall, I squash stuff already before I do a PR

@oscerd
Copy link
Contributor

oscerd commented May 16, 2024

Sorry for that.

@oscerd
Copy link
Contributor

oscerd commented May 16, 2024

The build seems to be fine. The website should be online in a few minutes

@squakez
Copy link
Contributor

squakez commented May 16, 2024

@tdiesler we did changes in autogenerated code in traits. It is likely that tonight it will be reverted back by auto updates. You need to change the content of the trait golang files and later make generate to refresh the autogen content.

@tdiesler
Copy link
Contributor Author

tdiesler commented May 21, 2024

I rebased those changes on main and see no differences. I believe I already changed stuff at the source i.e. the trait Go files. Also, I'm having trouble running make generate for some unknown reason - it works for @christophd who is also on MacOS when we last talked

@squakez
Copy link
Contributor

squakez commented May 21, 2024

See:

$ kamel run --trait 3scale.[key]=[value] --trait 3scale.[key2]=[value2] integration.groovy

We need to make the change on the go file and then, make generate.

@tdiesler
Copy link
Contributor Author

Like so ...
787a1d6

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.

None yet

4 participants