djencks commented on issue #1795: URL: https://github.com/apache/camel-quarkus/issues/1795#issuecomment-696892173
I’m not sure my suggestion is the best way forward, but I think there are more choices that use it. For one thing, you are pulling in the entire camel master site, rather than just components, which is going to increase the build time. It’s not actually necessary for the author-mode camel-quarkus build to generate the table for component-to-extension links; this would allow the build to use only the local sources. The contents of this table are not really susceptible to text changes, so it might be acceptable to build the whole site to check on the table and counts. Or, there could be two camel-quarkus author mode playbooks, one quarks-only and the other including the main components component. I don’t think it’s appropriate to fail a partial site build based on broken xrefs. This would mean that one part of the documentation can’t refer to another part. If there’s an agreed upon principle that there shouldn’t be cross-(antora-)component xrefs, it needs to be clearly stated somewhere :-) The include in the main camel component docs means that it would be easy to include a generated line, either “this component is in the camel-quarkus XXX extension” or “this component is not available in camel-quarkus”. Using one or multiple json files in camel-quarkus would not enable this. I ran some builds on my laptop and the results are inconsistent enough that I don’t really trust them, but I didn’t see a convincing increase in build time between the current whole-site build and my proposal. > On Sep 22, 2020, at 4:18 AM, Peter Palaga <notificati...@github.com> wrote: > > > I'd like to check how much time overhead will this bring > > I measured the yarn build duration in the following scenarios: > > Current Camel Quarkus master: ~12s > Adding the following snippet to antora-playbook.yml with Camel repo cached locally under ~/.cache/antora/content/2/: > - url: g...@github.com:apache/camel.git > branches: master > start_paths: > # manual > - docs/user-manual > # eip > - core/camel-core-engine/src/main/docs > # main components doc > - docs/components > 46s > > Same as 2. but without Camel repo cached locally under ~/.cache/antora/content/2/: 2m 54s > These numbers make me hesitant. > > There is one more issue with this setup: the yarn antora --generator @antora/xref-validator antora-playbook.yml fails with this setup. ATM, it is probably caused by some missing config on the Camel Quarkus side, but generally, I think we do not want to allow the possibility that broken xrefs in Camel docs can make our CI fail. What do others think? > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub <https://github.com/apache/camel-quarkus/issues/1795#issuecomment-696657766>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAELDXWMAITQB3D7H7UWW5DSHCBZDANCNFSM4RNIINJQ>. > ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
