fix(doc): broken links

[squakez]

• Excluded a private struct so it's no longer linked in the gen docs
• Workaround an issue reported to convert urlencoded chars

Fixes #2280

Release Note

NONE

[squakez]

cc @astefanutti @zregvart

[astefanutti]

Thanks!

[squakez]

Thanks for review. Feel free to merge it so we can see if the Camel Doc Build is happy now.

[oscerd]

The website it is still failing: https://ci-builds.apache.org/job/Camel/job/Camel.website/job/main/85/console @squakez @astefanutti

[squakez]

The website it is still failing: https://ci-builds.apache.org/job/Camel/job/Camel.website/job/main/85/console @squakez @astefanutti

Thanks @oscerd. What would be the suggested way to run those checks locally? I'd prefer to fix them all before submitting next PR.

[oscerd]

There is no easy way of doing this directly, I guess you may need to commit something here on camel-k repo and then run the website full build but @zregvart knows this better than myself.

[zregvart]

I'm going to exclude these pages from the checks, for that I need to upgrade the html-validate dependency and fix any issues new rules bring as ignoring certain files is a feature of the newer version. Checks can be run by running yarn checks, best after a production build by doing CAMEL_ENV=production yarn build-all. Some of this is explained in the https://github.com/apache/camel-website/ README.

[squakez]

Thanks @zregvart. I've included those checks in the camel k as well, so we can use to validate the subproject as well. The error I am getting are not exactly the same, but they should be enough to have an idea on what it will be failing on camel website. This is the PR.

If you've already skipped those checks, you may want to revert the one on public/camel-k/latest/apis/camel.html file. The other one failing (public/camel-k/latest/apis/crds-html.html) is something that could not be easily fixed, so we must skip that. However it should be not an issue as the page is just used for inclusion purposes.

[zregvart]

With apache/camel-website@07c4c3f this workaround might not be needed any more.