vscode-terraform
vscode-terraform copied to clipboard
Link to resources & data sources documentation
Problem Statement
The Terraform Registry provides documentation for provider resources and data sources, such as
- https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group
- https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/resource_group
It would be helpful for users to be able to easily get to the relevant docs from the source code.
Expected User Experience
The UI is the same as the one we use for provider docs currently:
Resources
resource "azurerm_resource_group" "example" {
name = "example"
location = "West Europe"
}
User is taken to the docs at https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group upon ctrl/cmd+click
on azurerm_resource_group
label.
Data Sources
data "azurerm_resource_group" "example" {
name = "existing"
}
User is taken to the docs at https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/resource_group upon ctrl/cmd+click
on azurerm_resource_group
label.
Proposal
- https://github.com/hashicorp/terraform-ls/issues/190
I thought the "ctrl/cmd+click
takes you to docs" feature already existed in this extension, and indeed there is an old closed issue where this was added years ago https://github.com/hashicorp/vscode-terraform/issues/68 I remember it being super useful.
I've just installed this extension on vscode on mac (big sur / apple silicon) and it doesn't seem to work, is it gone? Is it broken since docs website was revamped? I tried a few other extensions and only this one works: https://marketplace.visualstudio.com/items?itemName=SteefH.terraform-documentation-links .
I'd prefer not to have that other extension.