search

hashicorp / terraform

Terraform enables you to safely and predictably create, change, and improve infrastructure. It is a source-available tool that codifies APIs into declarative configuration files that can be shared amongst team members, treated as code, edited, reviewed, and versioned.
https://www.terraform.io/
Other
42.4k stars 9.5k forks source link

Enable links to subcategory sections in the Terraform.io website #28491

Closed cjcarpen closed 1 year ago

cjcarpen commented 3 years ago

Current Terraform Version

N/A - website (documentation) only

Use-cases

Our IBM Cloud Terraform provider docs contain resources and data sources for many different IBM Cloud services, which we've organized into subcategories. We want to link from the service's main product documentation to the specific subcategory for the service in the Terraform provider reference.

Attempted Solutions

Currently, we're linking to the first resource that's available underneath a subcategory, for example: https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/api_gateway_endpoint

image

This isn't ideal because the available resources can change, leading to a random landing spot or broken link.

Proposal

Generate an ID from the available subcategories in the website so that they have a linkable URL.

References

Searched but did not see any other issues related to the website behavior.

sean-freeman commented 1 year ago

@cjcarpen This appears to remain a functionality gap for the Terraform Registry; although I sense this is a design decision. As the Terraform Registry allows for multiple guide documents, an inefficient workaround to your request, would be to....

  1. Copy Markdown file for Index of Terraform on IBM Cloud resources and data sources
  2. Paste Markdown into provider subdirectory /website/docs/guides
crw commented 1 year ago

Just a note that the registry team does not work out of this repository; I will pass this issue along to give them a chance to add it to their backlog. Thanks for submitting this request!

github-actions[bot] commented 1 year ago

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.