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

Config Doc - Improve HTML Javadoc -> Asciidoc conversion #44679

Merged
merged 3 commits into from
Nov 25, 2024

Conversation

gsmet
Copy link
Member

@gsmet gsmet commented Nov 25, 2024

Note that these two issues were preexisting to the rewrite. I noticed them this week-end when I had a look at the config doc of quarkus.native.resources.includes to help a user.

I'm pretty sure it was a problem in other areas as well as things were quite wrong as soon as you had inline tags.

Also HTML tables were completely ignored and rendering raw text.

Before:

Screenshot from 2024-11-25 11-52-19

After (AsciiDoc local build):

Screenshot from 2024-11-25 12-37-02

Converting HTML to Asciidoc using the Javadoc elements was causing
issues as the HTML would be split and the fragments would be handled
without the knowledge of the HTML tree.
It will only handle very simple cases but it makes the doc for
quarkus.native.resources.includes a lot better.
Copy link

github-actions bot commented Nov 25, 2024

🎊 PR Preview 9361824 has been successfully built and deployed to https://quarkus-pr-main-44679-preview.surge.sh/version/main/guides/

  • Images of blog posts older than 3 months are not available.
  • Newsletters older than 3 months are not available.

Copy link

quarkus-bot bot commented Nov 25, 2024

Status for workflow Quarkus Documentation CI

This is the status report for running Quarkus Documentation CI on commit c4ba187.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

Warning

There are other workflow runs running, you probably need to wait for their status before merging.

@gsmet
Copy link
Member Author

gsmet commented Nov 25, 2024

@zakkak FYI the doc for quarkus.native.resources.includes was extremely bad due to some limitations/bugs of our historical HTML Javadoc -> Asciidoc transformation. It should be much better after this PR (noticed that when I checked the doc when discussing the Vert.x OpenAPI JSON schema thingy this week-end).

@gastaldi gastaldi added the triage/waiting-for-ci Ready to merge when CI successfully finishes label Nov 25, 2024
Copy link

quarkus-bot bot commented Nov 25, 2024

Status for workflow Quarkus CI

This is the status report for running Quarkus CI on commit c4ba187.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

You can consult the Develocity build scans.

@gsmet gsmet merged commit 9ff49c1 into quarkusio:main Nov 25, 2024
54 checks passed
@quarkus-bot quarkus-bot bot added this to the 3.18 - main milestone Nov 25, 2024
@quarkus-bot quarkus-bot bot removed the triage/waiting-for-ci Ready to merge when CI successfully finishes label Nov 25, 2024
@gsmet gsmet modified the milestones: 3.18 - main, 3.17.1 Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants