Link to (remote) module docs from module source

[radeksimko]

Problem Statement

The Terraform Registry automatically generates documentation for module authors from Readme.md and variables and outputs.

It would be helpful for users to be able to easily get to the overview/documentation of a module from the source code.

Expected User Experience

module "consul" {
  source = "hashicorp/consul/aws"
  version = "0.1.0"
}

User is taken to the docs at https://registry.terraform.io/modules/hashicorp/consul/aws/0.1.0 upon ctrl/cmd+click.

The UI is similar to the one we use for provider docs currently:

Proposal / TODO

• Enable DocsLink for attributes hcl-lang#115
• Add module source address parsing terraform-registry-address#7
• Add DocsLink for remote module source attributes terraform-schema#103
• Add version to module calls terraform-ls#874
• cmd+click behavior for Goto Definition and a Document Link microsoft/vscode#147447

[vide]

It might be unrelated but with the older, unofficial Terraform VSCode extension you could ctrl+click a resource name and get the help page for that resource on terraform.io/docs automatically. I'm not able anymore to achieve that, is it a missing feature or am I doing something wrong?

[radeksimko]

This is being tracked under hashicorp/terraform-ls#190 - we don't have a corresponding issue in this repo (yet) but all of the work will be done on the language server anyway.

Feel free to subscribe to that issue.

[dbanck]

Resolved via hashicorp/terraform-ls#874 and will be included in the 0.28.0 language server release.

[github-actions]

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.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.