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.

Sign up for GitHub

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

Jump to bottom

Improve formatting for enum configuration values #45988

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve formatting for enum configuration values #45988

wants to merge 1 commit into from

Conversation

gastaldi
Copy link
Contributor

@gastaldi gastaldi commented Jan 30, 2025 •
edited
Loading

  • Improve readability of enum configuration value formatting by switching to a bullet list style in documentation generation.

Before:
image

After:
image

@gastaldi gastaldi requested a review from gsmet January 30, 2025 18:40
@quarkus-bot quarkus-bot bot added the area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins label Jan 30, 2025
@quarkus-bot quarkus-bot

This comment has been minimized.

Sign in to view
@quarkus-bot quarkus-bot

This comment has been minimized.

Sign in to view
@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 30, 2025 •
edited
Loading

🎊 PR Preview 1597a94 has been successfully built and deployed to https://quarkus-pr-main-45988-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.

@quarkus-bot quarkus-bot

This comment has been minimized.

Sign in to view
@gsmet
Copy link
Member

gsmet commented Jan 30, 2025

Just to check: it doesn’t break things when there are tooltips with the enum javadoc?

@gastaldi
Copy link
Contributor Author

Just to check: it doesn’t break things when there are tooltips with the enum javadoc?

Correct, I haven't changed that part.

gsmet
gsmet requested changes Jan 31, 2025
View reviewed changes
Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a comment.

Make sure you validate how it goes on the preview of the website as we might have some problematic list styling.

...-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/generator/AbstractFormatter.java Outdated Show resolved Hide resolved
@gastaldi gastaldi force-pushed the options branch 2 times, most recently from 39d1349 to 755641f Compare January 31, 2025 13:23
@gastaldi gastaldi marked this pull request as draft January 31, 2025 13:34
@gastaldi
Improve formatting for enum configuration values
bb696c3 
- Improve readability of enum configuration value formatting by switching to a bullet list style in documentation generation.
@gastaldi gastaldi marked this pull request as ready for review January 31, 2025 13:41
@gastaldi gastaldi requested a review from gsmet January 31, 2025 13:44
@quarkus-bot quarkus-bot
Copy link

quarkus-bot bot commented Jan 31, 2025 •
edited by github-actions bot
Loading

Status for workflow Quarkus CI

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

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

You can consult the Develocity build scans.

@quarkus-bot quarkus-bot
Copy link

quarkus-bot bot commented Jan 31, 2025

Status for workflow Quarkus Documentation CI

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

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

@gastaldi
Copy link
Contributor Author

gastaldi commented Jan 31, 2025 •
edited
Loading

Here is a preview. It wasn't so pretty as in the docs.quarkiverse.io (probably because it's being right-aligned):

image

@gsmet
Copy link
Member

gsmet commented Jan 31, 2025

Yes it definitely needs some style adjustments, for the spacing and the alignment.

TBH, I wouldn't have a problem with everything being aligned to the left. But we will need to adjust the spacing for ul/li to make it work (specifically for the configuration reference).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gsmet gsmet Awaiting requested review from gsmet

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins triage/backport triage/backport-3.15
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@gastaldi @gsmet