Skip to content

Conversation

@rolfedh
Copy link
Contributor

@rolfedh rolfedh commented Nov 12, 2025

…k errors. Please backport to 3.27.

These URLs produce invalid links. Making them consistent with others.
These produce issues for downstream documentation. Please backport to 3.27.

@quarkus-bot
Copy link

quarkus-bot bot commented Nov 12, 2025

Thanks for your pull request!

Your pull request does not follow our editorial rules. Could you have a look?

  • title should not end up with ellipsis (make sure the title is complete)

This message is automatically generated by a bot.

@quarkus-bot quarkus-bot bot added area/docstyle issues related for manual docstyle review area/documentation labels Nov 12, 2025
@rolfedh rolfedh added triage/backport-3.27 and removed area/documentation area/docstyle issues related for manual docstyle review labels Nov 12, 2025
@quarkus-bot quarkus-bot bot added area/docstyle issues related for manual docstyle review area/documentation labels Nov 12, 2025
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.

Can you clarify the issue because I don't see how these links defer from others?

@rolfedh
Copy link
Contributor Author

rolfedh commented Nov 12, 2025

Can you clarify the issue because I don't see how these links defer from others?

Good question. This screenshot shows examples of other inline URLs that are enclosed in backticks.
image

Without the backticks, the URLs cause usability problems, which @mocenas describes in QUARKUS-6790:

https://ibmdocs-test.dcs.ibm.com/docs/en/quarkus/3.27.0?topic=ao-protect-service-application-by-using-oidc-bearer-token-authentication
This guide contains several links to "localhost:". These links doesn't work on IBM docs page. It will redirect you to some IBM page saying, it can't display this link and there is no way to progress to actual "localhost:". If there is no way to fix this, it would be IMHO best to disable those links.

@quarkus-bot
Copy link

quarkus-bot bot commented Nov 12, 2025

Status for workflow Quarkus Documentation CI

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

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

@github-actions
Copy link

github-actions bot commented Nov 12, 2025

🙈 The PR is closed and the preview is expired.

@gsmet
Copy link
Member

gsmet commented Nov 13, 2025

Yeah, my problem is that in the case you changed, we actually expect the user to click and have a look so not being able to link to it is unfortunate.

Could we try to contact the IBM doc team to better understand what's going on?

@rolfedh
Copy link
Contributor Author

rolfedh commented Nov 14, 2025

For users of the IBM docs, clicking these links opens a notification "This link is outside IBM's website do you want to proceed"-type of page. Clicking the link in that page should work if they're following the procedure. It might be better if the user copied and pasted the URL into an open blank tab. These types of link also produce link errors during testing. But none of this is a community docs issue.
I recommend closing this PR.

@rolfedh rolfedh closed this Nov 14, 2025
@quarkus-bot quarkus-bot bot added triage/invalid This doesn't seem right and removed triage/backport-3.27 labels Nov 14, 2025
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 triage/invalid This doesn't seem right

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants