Skip to content

Fixed docs for compute instance templates#8524

Merged
rileykarson merged 1 commit into
GoogleCloudPlatform:mainfrom
kvanzuijlen:docs-fix
Aug 2, 2023
Merged

Fixed docs for compute instance templates#8524
rileykarson merged 1 commit into
GoogleCloudPlatform:mainfrom
kvanzuijlen:docs-fix

Conversation

@kvanzuijlen

@kvanzuijlen kvanzuijlen commented Aug 2, 2023

Copy link
Copy Markdown
Contributor

The current docs give incorrect instructions for the scopes field in the compute instance template resources. This PR aims to fix those incorrect instructions.

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).
  • 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).
  • Generated Terraform providers, and ran make test and make lint in the generated providers to ensure it passes unit and linter tests.
  • Ran relevant acceptance tests using my own Google Cloud project and credentials (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know).
  • Read Write release notes before writing my release note below.

Release Note Template for Downstream PRs (will be copied)

computeengine: improved documentation for compute engine instance templates oauth scopes 

@google-cla

google-cla Bot commented Aug 2, 2023

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@modular-magician

Copy link
Copy Markdown
Collaborator

Hello! I am a robot. It looks like you are a community contributor. @rileykarson, a repository maintainer, has been assigned to review your changes. If you have not received review feedback within 2 business days, please leave a comment on this PR asking them to take a look.

You can help make sure that review is quick by doing a self-review and by running impacted tests locally.

@modular-magician modular-magician added the awaiting-approval Pull requests that need reviewer's approval to run presubmit tests label Aug 2, 2023
@bschaatsbergen

Copy link
Copy Markdown
Contributor

Happy to see you contributing to magic modules @kvanzuijlen - looking forward to more PRs 👍🏼🎉

@modular-magician modular-magician removed the awaiting-approval Pull requests that need reviewer's approval to run presubmit tests label Aug 2, 2023

@rileykarson rileykarson left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM- this is consistent with the guidance in google_compute_instance: https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_instance#scope. They used to say different things!

@modular-magician

Copy link
Copy Markdown
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 2 files changed, 8 insertions(+), 4 deletions(-))
Terraform Beta: Diff ( 2 files changed, 8 insertions(+), 4 deletions(-))
TF Conversion: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@bschaatsbergen

Copy link
Copy Markdown
Contributor

Thanks for picking this up so fast, much appreciated. Happy to see that several of my colleagues started actively contributing 😎

@kvanzuijlen kvanzuijlen deleted the docs-fix branch August 2, 2023 20:23
DanielRieske pushed a commit to bschaatsbergen/magic-modules that referenced this pull request Aug 2, 2023
simonebruzzechesse pushed a commit to simonebruzzechesse/magic-modules that referenced this pull request Aug 3, 2023
nevzheng pushed a commit to nevzheng/magic-modules that referenced this pull request Aug 3, 2023
jeperetz pushed a commit to jeperetz/magic-modules that referenced this pull request Aug 10, 2023
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.

4 participants