-
Notifications
You must be signed in to change notification settings - Fork 345
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
fix(doc): camel website error fixes #2288
Conversation
Thanks for this. We need also to wait for @zregvart PR on website build to make it working. |
Yeah, unfortunately the checks on one of the file is not easy to solve because it's a big html file encoded (I guess for a later inclusion by Antora). |
Not a big fan of the duplication of checks here. With that there are now two places where they need to be maintained. This will most likely cause them to go out of sync and produce false confidence. I think the root cause of these issues is that instead of asciidoc file a HTML file is build. We have yet to see how this will render on the website, and I'm skeptical that the overall look and feel will match the website design. I think we should focus on resolving the root cause of the issue, and in my opinion that would be generating the asciidoc file instead of HTML. |
The recent changes to the website now include the API documentation, this is how it looks at the moment. |
* Included an header that will be converted as title * Provided some workaround to fix HTML validation
Thanks @zregvart. I've removed the checks and fixed the templates instead of altering the output in order to have a cleaner output. Now we should be okey, apart the fact we're still generating an |
Fixed the script that generates the CRDs in order to workaround certain issues with gen-crd-api-references-docs. This should provide now a valid HTML.
The errors reported in the
public/camel-k/latest/apis/crds-html.html
file cannot be addressed as the content is converted to html encoded one by doc framework. This file is however just used as inclusion, so we can skip it from validation.cc @oscerd @zregvart @astefanutti
Release Note