Terraform provider docs update #2585

chrisst · 2019-11-05T19:16:37Z

upstream changes from hashicorp/terraform-provider-google#4795

I upstreamed the PR from @findkim, then had to make some updates on top of that. Including changes to the templating to generate the docs and manually adding subcategories for datasources.

I updated the datasources to have categories that are the same as their Resource equivalents. I believe this will nest them in the appropriate place, but we can revert that commit if we want to keep all datasources together.

Release Note Template for Downstream PRs (will be copied)

googlebot · 2019-11-05T19:16:45Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

modular-magician · 2019-11-05T19:26:16Z

Hi! I'm the modular magician, I work on Magic Modules.
I see that this PR has already had some downstream PRs generated. Any open downstreams are already updated to your most recent commit, 56c571c.

Pull request statuses

No diff detected in terraform-google-conversion.
No diff detected in Ansible.
No diff detected in Inspec.

New Pull Requests

I built this PR into one or more new PRs on other repositories, and when those are closed, this PR will also be merged and closed.
depends: hashicorp/terraform-provider-google-beta#1330
depends: hashicorp/terraform-provider-google#4815

modular-magician · 2019-11-05T19:31:43Z

Hi! I'm the modular magician, I work on Magic Modules.
I see that this PR has already had some downstream PRs generated. Any open downstreams are already updated to your most recent commit, 3315bab.

Pull request statuses

terraform-provider-google-beta already has an open PR.
No diff detected in terraform-google-conversion.
terraform-provider-google already has an open PR.
No diff detected in Ansible.
No diff detected in Inspec.

New Pull Requests

I didn't open any new pull requests because of this PR.

modular-magician · 2019-11-05T20:20:08Z

Hi! I'm the modular magician, I work on Magic Modules.
I see that this PR has already had some downstream PRs generated. Any open downstreams are already updated to your most recent commit, 790d1dc.

Pull request statuses

terraform-provider-google-beta already has an open PR.
No diff detected in terraform-google-conversion.
terraform-provider-google already has an open PR.
No diff detected in Ansible.
No diff detected in Inspec.

New Pull Requests

I didn't open any new pull requests because of this PR.

danawillow

I think as best as possible it makes sense to use the product names from https://cloud.google.com/products/ (so say cloud when it says cloud, otherwise don't). I'm also not convinced we need "Google" in front of all of them since the user should already be aware that they're looking at Google stuff. What do you think?

third_party/terraform/website/docs/d/datasource_compute_lb_ip_ranges.html.markdown

third_party/terraform/website/docs/d/google_compute_resource_policy.html.markdown

third_party/terraform/website/docs/d/signed_url.html.markdown

third_party/terraform/website/docs/d/storage_bucket_object.html.markdown

chrisst · 2019-11-05T22:33:17Z

@danawillow yeah it looks like the generated resources omit the "Google" somewhat frequently so probably time to make the cutover.

modular-magician · 2019-11-05T22:38:35Z

Hi! I'm the modular magician, I work on Magic Modules.
I see that this PR has already had some downstream PRs generated. Any open downstreams are already updated to your most recent commit, fec1982.

Pull request statuses

terraform-provider-google-beta already has an open PR.
No diff detected in terraform-google-conversion.
terraform-provider-google already has an open PR.
No diff detected in Ansible.
No diff detected in Inspec.

New Pull Requests

I didn't open any new pull requests because of this PR.

modular-magician · 2019-11-05T22:40:32Z

Hi! I'm the modular magician, I work on Magic Modules.
I see that this PR has already had some downstream PRs generated. Any open downstreams are already updated to your most recent commit, 519b1f4.

Pull request statuses

terraform-provider-google-beta already has an open PR.
No diff detected in terraform-google-conversion.
terraform-provider-google already has an open PR.
No diff detected in Ansible.
No diff detected in Inspec.

New Pull Requests

I didn't open any new pull requests because of this PR.

modular-magician · 2019-11-05T22:56:30Z

Hi! I'm the modular magician, I work on Magic Modules.
I see that this PR has already had some downstream PRs generated. Any open downstreams are already updated to your most recent commit, 00463c2.

Pull request statuses

terraform-provider-google-beta already has an open PR.
No diff detected in terraform-google-conversion.
terraform-provider-google already has an open PR.
No diff detected in Ansible.
No diff detected in Inspec.

New Pull Requests

I didn't open any new pull requests because of this PR.

danawillow · 2019-11-05T23:13:48Z

Took a look at the generated output, here are my notes on things that should probably be changed:

BigQueryDataTransfer
BigTable vs Bigtable
Google Cloud Run -> Cloud Run
Dataproc vs Cloud Dataproc
Key Management Service vs Cloud KMS
Cloud Pub/Sub vs PubSub
RuntimeConfig vs Cloud Runtime Configuration
Cloud Spanner vs Spanner
Cloud SQL vs SQL
Google Cloud TPU -> Cloud TPU (and add the tpu data source there too probably)

chrisst · 2019-11-05T23:18:13Z

@danawillow yup I was just finishing my cleanup. I am thinking of keeping some of the cleanup for things like "BigTable" vs "Bigtable" in separate PR's because I'm not yet sure how it will affect the other downstreams.

here are the current subcategories:

subcategory: "Access Context Manager"
subcategory: "App Engine"
subcategory: "BigQuery"
subcategory: "BigQueryDataTransfer"
subcategory: "BigTable"
subcategory: "Bigtable"
subcategory: "Binary Authorization"
subcategory: "Cloud Build"
subcategory: "Cloud Composer"
subcategory: "Cloud DNS"
subcategory: "Cloud Dataproc"
subcategory: "Cloud Filestore"
subcategory: "Cloud Firestore"
subcategory: "Cloud Functions"
subcategory: "Cloud Healthcare"
subcategory: "Cloud IoT Core"
subcategory: "Cloud KMS"
subcategory: "Cloud Memorystore"
subcategory: "Cloud Platform"
subcategory: "Cloud Pub/Sub"
subcategory: "Cloud Runtime Configuration"
subcategory: "Cloud SQL"
subcategory: "Cloud Scheduler"
subcategory: "Cloud Security Command Center"
subcategory: "Cloud Security Scanner"
subcategory: "Cloud Source Repositories"
subcategory: "Cloud Spanner"
subcategory: "Cloud Storage Transfer"
subcategory: "Cloud Storage"
subcategory: "Compute Engine"
subcategory: "Container Registry"
subcategory: "Dataflow"
subcategory: "Dataproc"
subcategory: "Endpoints"
subcategory: "Google Cloud Run"
subcategory: "Google Cloud TPU"
subcategory: "Identity-Aware Proxy"
subcategory: "Key Management Service"
subcategory: "Kubernetes (Container) Engine"
subcategory: "ML Engine"
subcategory: "PubSub"
subcategory: "Resource Manager"
subcategory: "RuntimeConfig"
subcategory: "SQL"
subcategory: "Serverless VPC Access"
subcategory: "Service Networking"
subcategory: "Spanner"
subcategory: "Stackdriver Logging"
subcategory: "Stackdriver Monitoring"

danawillow · 2019-11-05T23:24:41Z

Ah cool, looks like I got excited to review then 😛

A follow-up PR sounds totally fine. Let me know when this one is ready.

modular-magician · 2019-11-05T23:26:41Z

Hi! I'm the modular magician, I work on Magic Modules.
I see that this PR has already had some downstream PRs generated. Any open downstreams are already updated to your most recent commit, b134d19.

Pull request statuses

terraform-provider-google-beta already has an open PR.
No diff detected in terraform-google-conversion.
terraform-provider-google already has an open PR.
No diff detected in Ansible.
No diff detected in Inspec.

New Pull Requests

I didn't open any new pull requests because of this PR.

chrisst · 2019-11-05T23:54:09Z

@danawillow ok should be mostly clean now. I added #2590 for the yaml just in case there were downstream changes to other providers.

modular-magician · 2019-11-06T00:02:59Z

Hi! I'm the modular magician, I work on Magic Modules.
I see that this PR has already had some downstream PRs generated. Any open downstreams are already updated to your most recent commit, 7da3003.

Pull request statuses

terraform-provider-google-beta already has an open PR.
No diff detected in terraform-google-conversion.
terraform-provider-google already has an open PR.
No diff detected in Ansible.
No diff detected in Inspec.

New Pull Requests

I didn't open any new pull requests because of this PR.

modular-magician · 2019-11-06T00:57:34Z

Hi! I'm the modular magician, I work on Magic Modules.
I see that this PR has already had some downstream PRs generated. Any open downstreams are already updated to your most recent commit, d3e1499.

Pull request statuses

terraform-provider-google-beta already has an open PR.
No diff detected in terraform-google-conversion.
terraform-provider-google already has an open PR.
No diff detected in Ansible.
No diff detected in Inspec.

New Pull Requests

I didn't open any new pull requests because of this PR.

Tracked submodules are build/terraform-beta build/terraform-mapper build/terraform build/ansible build/inspec.

googlebot added the cla: no label Nov 5, 2019

modular-magician added downstream-generated terraform-provider-google-beta terraform-provider-google labels Nov 5, 2019

findkim mentioned this pull request Nov 5, 2019

website: Add subcategories to docs for display on the Terraform Registry hashicorp/terraform-provider-google#4795

Closed

chrisst requested a review from danawillow November 5, 2019 20:11

danawillow suggested changes Nov 5, 2019

View reviewed changes

chrisst force-pushed the terraform-provider-docs-update branch from 519b1f4 to 00463c2 Compare November 5, 2019 22:45

danawillow approved these changes Nov 6, 2019

View reviewed changes

chrisst force-pushed the terraform-provider-docs-update branch from 7da3003 to d3e1499 Compare November 6, 2019 00:47

modular-magician added the automerged label Nov 6, 2019

findkim and others added 4 commits November 6, 2019 18:44

Add subcategories to data source and resource docs

6b99070

Use display_name as the website subcategory

3d13d22

Add exclusion for docscheck.sh to generation scripts

e89a499

Assign subcategories to datasources

8a128d1

chrisst and others added 5 commits November 6, 2019 18:44

Prefer Cloud Storage

fa94295

Remove superflous 'Google' from subcategories

add7ac0

cleanup container subcategory

56dce61

Renaming subcategories to be consistent

586087b

Update tracked submodules -> HEAD on Wed Nov 6 18:44:09 UTC 2019

f877deb

Tracked submodules are build/terraform-beta build/terraform-mapper build/terraform build/ansible build/inspec.

modular-magician force-pushed the terraform-provider-docs-update branch from d3e1499 to f877deb Compare November 6, 2019 18:44

modular-magician merged commit 33694c7 into GoogleCloudPlatform:master Nov 6, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Terraform provider docs update #2585

Terraform provider docs update #2585

chrisst commented Nov 5, 2019 •

edited

Loading

googlebot commented Nov 5, 2019

modular-magician commented Nov 5, 2019

modular-magician commented Nov 5, 2019

modular-magician commented Nov 5, 2019

danawillow left a comment

chrisst commented Nov 5, 2019

modular-magician commented Nov 5, 2019

modular-magician commented Nov 5, 2019

modular-magician commented Nov 5, 2019

danawillow commented Nov 5, 2019

chrisst commented Nov 5, 2019

danawillow commented Nov 5, 2019

modular-magician commented Nov 5, 2019

chrisst commented Nov 5, 2019

modular-magician commented Nov 6, 2019

modular-magician commented Nov 6, 2019

Terraform provider docs update #2585

Terraform provider docs update #2585

Conversation

chrisst commented Nov 5, 2019 • edited Loading

googlebot commented Nov 5, 2019

modular-magician commented Nov 5, 2019

Pull request statuses

New Pull Requests

modular-magician commented Nov 5, 2019

Pull request statuses

New Pull Requests

modular-magician commented Nov 5, 2019

Pull request statuses

New Pull Requests

danawillow left a comment

Choose a reason for hiding this comment

chrisst commented Nov 5, 2019

modular-magician commented Nov 5, 2019

Pull request statuses

New Pull Requests

modular-magician commented Nov 5, 2019

Pull request statuses

New Pull Requests

modular-magician commented Nov 5, 2019

Pull request statuses

New Pull Requests

danawillow commented Nov 5, 2019

chrisst commented Nov 5, 2019

danawillow commented Nov 5, 2019

modular-magician commented Nov 5, 2019

Pull request statuses

New Pull Requests

chrisst commented Nov 5, 2019

modular-magician commented Nov 6, 2019

Pull request statuses

New Pull Requests

modular-magician commented Nov 6, 2019

Pull request statuses

New Pull Requests

chrisst commented Nov 5, 2019 •

edited

Loading