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

Updated link text for consistency #44192

Closed
wants to merge 1 commit into from

Conversation

rolfedh
Copy link
Contributor

@rolfedh rolfedh commented Oct 30, 2024

Updated the link text for user clarity and consistency.

@quarkus-bot
Copy link

quarkus-bot bot commented Oct 30, 2024

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 dot

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 Oct 30, 2024
@rolfedh rolfedh changed the title Updated link text for consistency. Updated link text for consistency Oct 30, 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.

-1 for the change

I would keep it as is for consistency within the guide, see the official documentation phrase is used in other places (I count 7 places in https://github.com/quarkusio/quarkus/blob/e535aa62b0021a5324dc4a30348fd617a6b0baa1/docs/src/main/asciidoc/datasource.adoc)

Can you elaborate on "Updated link text for consistency"? consistency with what?

Copy link

github-actions bot commented Oct 30, 2024

🙈 The PR is closed and the preview is expired.

@quarkus-bot

This comment has been minimized.

@rolfedh
Copy link
Contributor Author

rolfedh commented Oct 30, 2024

-1 for the change

I would keep it as is for consistency within the guide, see the official documentation phrase is used in other places (I count 7 places in https://github.com/quarkusio/quarkus/blob/e535aa62b0021a5324dc4a30348fd617a6b0baa1/docs/src/main/asciidoc/datasource.adoc)

Can you elaborate on "Updated link text for consistency"? consistency with what?

Thanks for your feedback @rsvoboda.

When I first made this change, I hadn’t noticed the many other instances of “official documentation.” My goal was to add clarity by addressing questions like “Whose official documentation?” (MySQL’s) and “What is the subject of this documentation?” (Connector/J Developer Guide).

I agree that this change would benefit from a more comprehensive review and some discussion. With that in mind, I’m closing this PR.

@rolfedh rolfedh closed this Oct 30, 2024
@quarkus-bot quarkus-bot bot added triage/invalid This doesn't seem right and removed triage/backport-3.15 labels Oct 30, 2024
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.

4 participants