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

fix(doc): camel website error fixes #2288

Merged
merged 4 commits into from
May 27, 2021
Merged

fix(doc): camel website error fixes #2288

merged 4 commits into from
May 27, 2021

Conversation

squakez
Copy link
Contributor

@squakez squakez commented May 12, 2021

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

NONE

@oscerd
Copy link
Contributor

oscerd commented May 12, 2021

Thanks for this. We need also to wait for @zregvart PR on website build to make it working.

@squakez squakez mentioned this pull request May 12, 2021
@squakez
Copy link
Contributor Author

squakez commented May 12, 2021

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

@zregvart
Copy link
Member

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.

@zregvart
Copy link
Member

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
@squakez
Copy link
Contributor Author

squakez commented May 13, 2021

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 html included in an asciidoc. I've created an issue in order to change the templates and have directly an asciidoc output. The actual output is far to be perfect, but it's a first step to start with.

@nicolaferraro nicolaferraro merged commit e348e44 into apache:main May 27, 2021
@nicolaferraro nicolaferraro mentioned this pull request Jul 2, 2021
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