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

Ensure relative links in markdown are interpreted #323

Open
radeksimko opened this issue Feb 12, 2024 · 0 comments
Open

Ensure relative links in markdown are interpreted #323

radeksimko opened this issue Feb 12, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@radeksimko
Copy link
Member

radeksimko commented Feb 12, 2024

Context

As described in hashicorp/terraform#34510 the Markdown descriptions, which includes both provider schema and any (core or future provider) functions, may contain relative links.

This is not currently handled in any way, i.e. we just keep the links as-is.

One example is sensitive function:

Description: "`sensitive` takes any value and returns a copy of it marked so that Terraform will treat it as sensitive, with the same meaning and behavior as for [sensitive input variables](/language/values/variables#suppressing-values-in-cli-output).",

The result is the following unfortunate UX:

2024-02-12 17 07 36

Proposal

While the problem is surfaced to the user in the language server, I believe that the links should get resolved into absolute ones as soon as the JSON output is consumed and turned into Go as it I think it may get more difficult afterwards.

I leave it up to you to decide on the solution though - I'm just providing context on why I filed the issue here and not in terraform-ls.

Related

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant