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

Align manually generated documentation with #5192 #5279

Merged
merged 2 commits into from
Oct 15, 2021

Conversation

juliocc
Copy link
Contributor

@juliocc juliocc commented Oct 5, 2021

This PR adds internal links for nested types to manually generated pages, similar to #5192.

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 for manually generated pages

@google-cla google-cla bot added the cla: yes label Oct 5, 2021
@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.

@melinath, 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 ( 45 files changed, 465 insertions(+), 463 deletions(-))
Terraform Beta: Diff ( 46 files changed, 466 insertions(+), 464 deletions(-))

@modular-magician
Copy link
Collaborator

I have triggered VCR tests in RECORDING mode for the following tests that failed during VCR: TestAccDatasourceGoogleServiceNetworkingPeeredDnsDomain_basic|TestAccServiceNetworkingPeeredDNSDomain_basic You can view the result here: https://ci-oss.hashicorp.engineering/viewQueued.html?itemId=209156

This commit add internal links for nested types to manually generated
pages, similar to GoogleCloudPlatform#5192.
@juliocc
Copy link
Contributor Author

juliocc commented Oct 13, 2021

Is thee interest in this? If so, I can fix the conflict.

@melinath
Copy link
Member

@juliocc yes, I'm working on reviewing it, it's just a very long and tedious process for this kind of PR. If you could fix the conflict that would be great.

Copy link
Member

@melinath melinath left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the delay, this took a while to go through and verify the links. In the future, please split changes like this into multiple PRs, ideally grouped in some logical way, like changes to similar resources.

I've marked the links that seem to have issues. Thanks for contributing!

@juliocc
Copy link
Contributor Author

juliocc commented Oct 14, 2021

Apologies for XL PR. Wasn't sure what was better (single XL or multiple smaller).

I'll rebase and fix the comments during the day.

@juliocc juliocc force-pushed the jccb/nested-types-links2 branch from 54c42e4 to 9336cec Compare October 15, 2021 13:53
@juliocc juliocc force-pushed the jccb/nested-types-links2 branch from 9336cec to 44b946d Compare October 15, 2021 14:03
@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 ( 45 files changed, 465 insertions(+), 462 deletions(-))
Terraform Beta: Diff ( 46 files changed, 466 insertions(+), 463 deletions(-))

@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 ( 45 files changed, 465 insertions(+), 462 deletions(-))
Terraform Beta: Diff ( 45 files changed, 465 insertions(+), 462 deletions(-))

Copy link
Member

@melinath melinath left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@modular-magician
Copy link
Collaborator

I have triggered VCR tests in RECORDING mode for the following tests that failed during VCR: TestAccDatasourceGoogleServiceNetworkingPeeredDnsDomain_basic|TestAccComputeForwardingRule_update|TestAccContainerCluster_withAddons|TestAccContainerCluster_withWorkloadIdentityConfigDeprecation|TestAccContainerCluster_withWorkloadIdentityConfig|TestAccServiceNetworkingPeeredDNSDomain_basic You can view the result here: https://ci-oss.hashicorp.engineering/viewQueued.html?itemId=210853

@modular-magician
Copy link
Collaborator

Tests failed during RECORDING mode: TestAccDatasourceGoogleServiceNetworkingPeeredDnsDomain_basic|TestAccServiceNetworkingPeeredDNSDomain_basic Please fix these to complete your PR

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