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

Added support quick-jumping to web-based documentation #19

Merged
merged 1 commit into from
Mar 1, 2023

Conversation

obicons
Copy link

@obicons obicons commented Jun 12, 2018

When working on Terraform, I commonly need to jump to documentation. I find myself jumping back and forth between Terraform's documentation and Emacs frequently.

This code adds support for hitting "M-." while the point is positioned at a resource to automatically navigate to Terraform's web-based documentation.

terraform-mode.el Outdated Show resolved Hide resolved
terraform-mode.el Outdated Show resolved Hide resolved
terraform-mode.el Outdated Show resolved Hide resolved
terraform-mode.el Outdated Show resolved Hide resolved
@dod38fr
Copy link
Contributor

dod38fr commented Nov 17, 2022

For team work in a team where not all people use emacs, it would also be useful to add a comment containing a link to documentation above the resource. I.e. something like:

# https://github.com/cloudposse/terraform-aws-tfstate-backend
module "terraform_state_backend" {
  source = "cloudposse/tfstate-backend/aws"

where the comment was added by terraform-mode.

@Fuco1 Fuco1 force-pushed the added-doc-support branch from 9baad76 to d65b1aa Compare March 1, 2023 13:57
@dod38fr
Copy link
Contributor

dod38fr commented Mar 4, 2023

@Fuco1 Thanks a bunch. I'll test this next week :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants