-
Notifications
You must be signed in to change notification settings - Fork 130
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
Add docs links to document and hover #402
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
191c871
to
49e956f
Compare
this PR does not allow going to resource documentation, only provider. |
this only works on provider block example: versions.tf
in this example hover is not working. |
I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. |
Depends on hashicorp/hcl-lang#8
Depends on hashicorp/terraform-schema#10
This adds links to relevant documentation for providers via hover data and
documentLink
method, which then results in the following UX in VS Code:Maybe this is not the best UX, but we don't have any control over how clients (such as VS Code) use the
documentLink
and if at all. Sublime Text for example doesn't implement it at all, so we are left with just hover:I don't have strong opinion on how we link to docs UX-wise, but I think we could just roll it out and see how people (dis)like it.
Relatedly the UTM parameters will help us identify any click-throughs to the Registry using any of these two features. All URLs have these parameters appended:
utm_source=terraform-ls
utm_content
- e.g.documentLink
ordocumentHover
utm_media
- e.g.vscode
orSublime Text LSP