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

Fixing the badly ended conditionals #44294

Merged
merged 1 commit into from
Nov 4, 2024

Conversation

MichalMaler
Copy link
Contributor

Previously, I created conditionals that were not properly ended.
This fix is maybe a solution for the troubles caused during the downstreaming of this guide.
Ref:

Signed-off-by: Michal Maléř <mmaler@redhat.com>
@MichalMaler MichalMaler added triage/waiting-for-ci Ready to merge when CI successfully finishes triage/backport-3.15 labels Nov 4, 2024
@jmartisk jmartisk merged commit d8f1436 into quarkusio:main Nov 4, 2024
5 checks passed
@quarkus-bot quarkus-bot bot removed the triage/waiting-for-ci Ready to merge when CI successfully finishes label Nov 4, 2024
@quarkus-bot quarkus-bot bot added this to the 3.17 - main milestone Nov 4, 2024
Copy link
Member

@rsvoboda rsvoboda left a comment

Choose a reason for hiding this comment

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

For the future, @MichalMaler is there a way to validate adocs by a tool to prevent issues like this?

Copy link

github-actions bot commented Nov 4, 2024

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

@MichalMaler MichalMaler deleted the Datasource-guide-indef-fix branch November 4, 2024 15:16
@MichalMaler
Copy link
Contributor Author

For the future, @MichalMaler is there a way to validate adocs by a tool to prevent issues like this?

We don't have such a tool right now, but I agree it would be great to have something that can check if all conditions are properly enclosed.
It was a silly mistake by me, but on the other hand, that's why we have reviews.

@rsvoboda
Copy link
Member

rsvoboda commented Nov 4, 2024

It was a silly mistake by me, but on the other hand, that's why we have reviews.

With a load of pull requests landing to the Quarkus repo, I don't think it's a reasonable expectation. Creator/Owner of the PR is the primary responsible person and that's also why having a tool that would help identify incorrect syntax would help.

@MichalMaler
Copy link
Contributor Author

It was a silly mistake by me, but on the other hand, that's why we have reviews.

With a load of pull requests landing to the Quarkus repo, I don't think it's a reasonable expectation. Creator/Owner of the PR is the primary responsible person and that's also why having a tool that would help identify incorrect syntax would help.

Hey, I don't blame anyone! :) It was all my fault. I will put this on my todo list.
I agree that this should be caught automatically.

@jmartisk
Copy link
Contributor

jmartisk commented Nov 5, 2024

We do have a bazillion documentation-related automated checks in the upstream CI, how come none of them caught this?

@jmartisk
Copy link
Contributor

jmartisk commented Nov 5, 2024

I guess the problem is that an unterminated ifndef/ifdef macro is actually legal, and the (asciidoc-maven-plugin) compiler in this case just treats the whole rest of the document (behind this macro) to be part of this macro, and doesn't throw any errors. And only Pantheon seems to handle it by failing (without a reasonable error message). To check for unterminated macros, we would have to write our own custom check, I think.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docstyle issues related for manual docstyle review area/documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants