question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Feature request: linking to terraform documentation

See original GitHub issue

This one is a feature request. It would be nice to be able to press shift+F1 on a resource (and maybe even data, backend, provider, etc) and have it take you to straight to the Terraform docs. This feature is called External Documentation in the keymap. It’s supported pretty well for Java and Python methods.

Example:

resource "aws_instance" "my-machine" {

Putting the cursor on aws_instance and hitting shift+F1 would take you here.

Another nice-to-have would be ctrl+q, or Quick Documentation. This pops up a window right in the IDE.

I’m not sure whether Terraform has enough metadata about the resources to make this possible. Keeping a manual list of URLs would not be fun. Either way, this is on my wishlist 😃

Issue Analytics

  • State:open
  • Created 6 years ago
  • Reactions:39
  • Comments:11 (2 by maintainers)

github_iconTop GitHub Comments

8reactions
M1kepcommented, Feb 7, 2022

I just installed version 0.7.15 and it works, BUT it appends .html to the webpage which breaks the link as the TF Registry docs don’t support the .html

6reactions
eschwartzcommented, Mar 26, 2018

This would be so helpful! Terraform docs are difficult to navigate and locate (especially for AWS, where I have to scroll for days to find anything), so being able to jump right to the documentation would save a lot of time

Read more comments on GitHub >

github_iconTop Results From Across the Web

AWS Provider - hashicorp
Browse aws documentation ... By default, the underlying AWS client used by the Terraform AWS Provider creates requests with User-Agent headers including ...
Read more >
Feature Sets - API Docs - Terraform Cloud
Note: The feature sets API is only available in Terraform Cloud. Feature sets represent the different pricing plans available to Terraform Cloud organizations....
Read more >
Terraform integration in merge requests - GitLab Docs
Using the GitLab Terraform Report artifact, you can expose details from terraform plan runs directly into a merge request widget, enabling you to...
Read more >
HashiCorp Terraform - Visual Studio Marketplace
For Terraform constructs like resource and data, labels, blocks and attributes are auto completed both at the root of the document and inside ......
Read more >
Terraform on Google Cloud documentation
Using Terraform with Google Cloud Platform. ... This tutorial shows you how to use Terraform to deploy a FortiGate reference architecture to help...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found