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

Linking in documentation leading to misread character #32423

Open
lukiffer opened this issue Dec 21, 2022 · 1 comment
Open

Linking in documentation leading to misread character #32423

lukiffer opened this issue Dec 21, 2022 · 1 comment
Labels
documentation new new issue not yet triaged

Comments

@lukiffer
Copy link

Terraform Version

1.3.4

Affected Pages

https://developer.hashicorp.com/terraform/language/expressions/version-constraints

from source

https://github.com/hashicorp/terraform/blob/main/website/docs/language/expressions/version-constraints.mdx

What is the docs issue?

When viewing the markdown directly, the documentation is clear. However, on the developer.hashicorp.com website, linking is applied to each of the bulleted lists.

This leads to the > character (when linked and underlined) to read like the character, which is not supported.

In context with the rest of the document, it's clear what my mistake was, but not sure if anything can be done to avoid that mistake in the first place.

Proposal

A few options could prevent the issue:

  • Add an invisible anchor to avoid linking of the actual text in bullets.
  • Add an invisible markdown marker observed by the HTML converter to omit links to specific lines.

References

No response

@lukiffer lukiffer added documentation new new issue not yet triaged labels Dec 21, 2022
@crw
Copy link
Collaborator

crw commented Jan 6, 2023

Thanks for this report! I've notified the docs team.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation new new issue not yet triaged
Projects
None yet
Development

No branches or pull requests

2 participants