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

Link nested types in resource documentation pages #5192

Merged

Conversation

juliocc
Copy link
Contributor

@juliocc juliocc commented Sep 13, 2021

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 

@google-cla google-cla bot added the cla: yes label Sep 13, 2021
@modular-magician
Copy link
Collaborator

Oops! It looks like no changelog entry is attached to this PR. Please include a release note block in the PR body, as described in https://github.com/GoogleCloudPlatform/magic-modules/blob/master/.ci/RELEASE_NOTES_GUIDE.md:

```release-note:TYPE
Release note
```

@modular-magician
Copy link
Collaborator

Hello! I am a robot who works on Magic Modules PRs.

I have detected that you are a community contributor, so your PR will be assigned to someone with a commit-bit on this repo for initial review.

Thanks for your contribution! A human will be with you soon.

@rileykarson, please review this PR or find an appropriate assignee.

@modular-magician
Copy link
Collaborator

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 148 files changed, 1857 insertions(+), 1857 deletions(-))
Terraform Beta: Diff ( 150 files changed, 1859 insertions(+), 1860 deletions(-))

@rileykarson
Copy link
Member

Thanks @juliocc! This is very useful.

@rileykarson rileykarson merged commit 21d9f76 into GoogleCloudPlatform:master Sep 13, 2021
khajduczenia pushed a commit to khajduczenia/magic-modules that referenced this pull request Oct 12, 2021
juliocc added a commit to juliocc/magic-modules that referenced this pull request Oct 15, 2021
This commit add internal links for nested types to manually generated
pages, similar to GoogleCloudPlatform#5192.
melinath pushed a commit that referenced this pull request Oct 15, 2021
* Align manually generated documentation with #5192

This commit add internal links for nested types to manually generated
pages, similar to #5192.

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

Successfully merging this pull request may close these issues.

3 participants