Skip to content

Link nested types in resource documentation pages #3615

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

Conversation

modular-magician
Copy link
Collaborator

This PR add links to nested data types within a resource's documentation page, simplifying navigation for complex resources with multiple nested types.

Format was tested against Terraform's doc preview tool and the syntax works as expected.

If this PR is for Terraform, I acknowledge that I have:

  • Searched through the issue tracker for an open issue that this either resolves or contributes to, commented on it to claim it, and written "fixes {url}" or "part of {url}" in this PR description. If there were no relevant open issues, I opened one and commented that I would like to work on it (not necessary for very small changes).
  • Generated Terraform, and ran make test and make lint to ensure it passes unit and linter tests.
  • Ensured that all new fields I added that can be set by a user appear in at least one example (for generated resources) or third_party test (for handwritten resources or update tests).
  • Ran relevant acceptance tests (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know).
  • Read the Release Notes Guide before writing my release note below.

Release Note Template for Downstream PRs (will be copied)

provider: Added links to nested types documentation within a resource 

Derived from GoogleCloudPlatform/magic-modules#5192

Sorry, something went wrong.

Signed-off-by: Modular Magician <magic-modules@google.com>
@modular-magician modular-magician merged commit 15043a5 into hashicorp:master Sep 13, 2021
@modular-magician modular-magician deleted the downstream-pr-21d9f76cae689ed1efd19c2079d7f49e884cf94a branch November 16, 2024 02:19
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.

None yet

1 participant