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

Expose links to documentation of resources & data sources #417

Closed
radeksimko opened this issue Feb 23, 2021 · 2 comments
Closed

Expose links to documentation of resources & data sources #417

radeksimko opened this issue Feb 23, 2021 · 2 comments

Comments

@radeksimko
Copy link
Member

radeksimko commented Feb 23, 2021

Current Version

0.14.0

Use-cases

#402 introduced links for provider docs

Users would also benefit from easier access to documentation to the relevant page in docs for a resource or a data source.

For example:

resource "aws_instance" "name" { # <-- clickable "aws_instance"
 # ...
}

Proposal

Currently deep links to resources and data sources aren't predictable, which is why they were omitted from #402

Therefore a new "redirect" endpoint need to be introduced first to the Terraform Registry API which can automatically redirect to the relevant page based on provider slug + version and resource/datasource name.

Then we can just follow the implementation in #402

@radeksimko
Copy link
Member Author

Actually I'm going to close this in favour of #190

@ghost
Copy link

ghost commented Mar 25, 2021

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 context necessary to investigate further.

@ghost ghost locked as resolved and limited conversation to collaborators Mar 25, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant