camel-k icon indicating copy to clipboard operation
camel-k copied to clipboard

Published 20 hours ago • verified publisher icon apache

(#5489) Docs index - how it works

Open tdiesler opened this issue 9 months ago • 2 comments

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

tdiesler avatar May 10 '24 13:05 tdiesler

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'"

tdiesler avatar May 10 '24 15:05 tdiesler

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.

squakez avatar May 13 '24 07:05 squakez

:warning: Unit test coverage report - coverage decreased from 38.2% to 38.1% (-0.1%)

github-actions[bot] avatar May 14 '24 12:05 github-actions[bot]

All docs should be done - ready to merge

tdiesler avatar May 15 '24 11:05 tdiesler

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.

oscerd avatar May 15 '24 12:05 oscerd 

$ ./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

tdiesler avatar May 15 '24 13:05 tdiesler 

$ ./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

oscerd avatar May 15 '24 13:05 oscerd

Could we run this again pls?

tdiesler avatar May 15 '24 16:05 tdiesler

Ready to merge

tdiesler avatar May 16 '24 07:05 tdiesler

https://ci-builds.apache.org/job/Camel/job/Camel.website/job/main/1612/

oscerd avatar May 16 '24 07:05 oscerd

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

tdiesler avatar May 16 '24 07:05 tdiesler

Sorry for that.

oscerd avatar May 16 '24 07:05 oscerd

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

oscerd avatar May 16 '24 08:05 oscerd

@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.

squakez avatar May 16 '24 14:05 squakez

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

tdiesler avatar May 21 '24 10:05 tdiesler

See: https://github.com/apache/camel-k/blob/4317da83d0f15137b12da6a2204d2543bd9e4603/docs/modules/traits/pages/3scale.adoc?plain=1#L21

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

squakez avatar May 21 '24 10:05 squakez

Like so ... https://github.com/apache/camel-k/pull/5518/commits/787a1d6f826be2a94523ed06588586387be574fe

tdiesler avatar May 21 '24 13:05 tdiesler