Skip to content

Commit

Permalink
Remove page_title attribute from frontmatter in resource documentat…
Browse files Browse the repository at this point in the history
…ion, update external link (#7151)

* Remove `page_title` frontmatter from generated resource documentation

* Update link to custom timeouts in HashiCorp docs

* Remove `page_title` frontmatter from generated IAM resource documentation

* Remove `page_title` frontmatter from tpgtools documentation template

* Remove use of `page_title` in handwritten resource/datasource docs

* Update link to custom timeout docs in handwritten resource/datasource docs

* Update link to custom timeout docs in tpgtools docs template
  • Loading branch information
SarahFrench authored Jan 26, 2023
1 parent 0ae27f3 commit 62a62f2
Show file tree
Hide file tree
Showing 240 changed files with 48 additions and 288 deletions.
3 changes: 1 addition & 2 deletions mmv1/templates/terraform/resource.html.markdown.erb
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@
---
<%= lines(autogen_notice(:yaml, pwd)) -%>
subcategory: "<%= tf_subcategory -%>"
page_title: "Google: <%= terraform_name -%>"
description: |-
<%= indent(object.description.first_sentence, 2) %>
---
Expand Down Expand Up @@ -173,7 +172,7 @@ In addition to the arguments listed above, the following computed attributes are
## Timeouts

This resource provides the following
[Timeouts](/docs/configuration/resources.html#timeouts) configuration options:
[Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options:

- `create` - Default is <%= timeouts.insert_minutes -%> minutes.
<% if updatable?(object, properties) -%>
Expand Down
1 change: 0 additions & 1 deletion mmv1/templates/terraform/resource_iam.html.markdown.erb
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@
---
<%= lines(autogen_notice(:yaml, pwd)) -%>
subcategory: "<%= tf_subcategory -%>"
page_title: "Google: <%= resource_ns_iam -%>"
description: |-
Collection of resources to manage IAM policy for <%= product.display_name -%> <%= object.name %>
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Access Approval"
page_title: "Google: google_access_approval_folder_service_account"
description: |-
Get the email address of a folder's Access Approval service account.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Access Approval"
page_title: "Google: google_access_approval_organization_service_account"
description: |-
Get the email address of an organization's Access Approval service account.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Access Approval"
page_title: "Google: google_access_approval_project_service_account"
description: |-
Get the email address of a project's Access Approval service account.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Cloud Platform"
page_title: "Google: google_active_folder"
description: |-
Get a folder within GCP.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "App Engine"
page_title: "Google: google_app_engine_default_service_account"
description: |-
Retrieve the default App Engine service account used in this project
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Artifact Registry Repository"
page_title: "Google: google_artifact_registry_repository"
description: |-
Get information about a Google Artifact Registry Repository.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "BeyondCorp"
page_title: "Google: google_beyondcorp_app_connection"
description: |-
Get information about a Google BeyondCorp App Connection.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "BeyondCorp"
page_title: "Google: google_beyondcorp_app_connector"
description: |-
Get information about a Google BeyondCorp App Connector.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "BeyondCorp"
page_title: "Google: google_beyondcorp_app_gateway"
description: |-
Get information about a Google BeyondCorp App Gateway.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "BigQuery"
page_title: "Google: google_bigquery_default_service_account"
description: |-
Get the email address of the project's BigQuery service account
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Cloud Billing"
page_title: "Google: google_billing_account"
description: |-
Get information about a Google Billing Account.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Cloud Platform"
page_title: "Google: google_client_config"
description: |-
Get information about the configuration of the Google Cloud provider.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Cloud Platform"
page_title: "Google: google_client_openid_userinfo"
description: |-
Get OpenID userinfo about the credentials used with the Google provider, specifically the email.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Cloud Asset Inventory"
page_title: "Google: google_cloud_asset_resources_search_all"
description: |-
Retrieve all the resources within a given accessible CRM scope (project/folder/organization).
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Cloud Identity"
page_title: "Google: google_cloud_identity_group_memberships"
description: |-
Get list of the Cloud Identity Group Memberships within a Group.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Cloud Identity"
page_title: "Google: google_cloud_identity_groups"
description: |-
Get list of the Cloud Identity Groups under a customer or namespace.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Cloud Run"
page_title: "Google: google_cloud_run_locations"
description: |-
Get Cloud Run locations available for a project.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Cloud Run"
page_title: "Google: google_cloud_run_service"
description: |-
Get information about a Google Cloud Run Service.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Cloud Build"
page_title: "Google: google_cloudbuild_trigger"
description: |-
Get information about a Google CloudBuild Trigger.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Cloud Functions (2nd gen)"
page_title: "Google: google_cloudfunctions2_function"
description: |-
Get information about a Google Cloud Function (2nd gen).
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Cloud Functions"
page_title: "Google: google_cloudfunctions_function"
description: |-
Get information about a Google Cloud Function.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Cloud Composer"
page_title: "Google: google_composer_environment"
description: |-
Provides Cloud Composer environment configuration data.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Cloud Composer"
page_title: "Google: google_composer_image_versions"
description: |-
Provides available Cloud Composer versions.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_address"
description: |-
Get the IP address from a static address.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_addresses"
description: |-
List google compute addresses.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_backend_bucket"
description: |-
Get information about a BackendBucket.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_backend_service"
description: |-
Get information about a Backend Service.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_default_service_account"
description: |-
Retrieve default service account used by VMs running in this project
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_disk"
description: |-
Get information about a Google Compute Persistent disks.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_forwarding_rule"
description: |-
Get a regional forwarding rule within GCE.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_global_address"
description: |-
Get the IP address from a static address reserved for a Global Forwarding Rule.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_global_forwarding_rule"
description: |-
Get a global forwarding rule within GCE.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_ha_vpn_gateway"
description: |-
Get a HA VPN Gateway within GCE.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_health_check"
description: |-
Get information about a HealthCheck.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_image"
description: |-
Get information about a Google Compute Image.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_instance"
description: |-
Get a VM instance within GCE.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_instance_group"
description: |-
Get a Compute Instance Group within GCE.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_instance_group_manager"
description: |-
Get a Compute Instance Group within GCE.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_instance_serial_port"
description: |-
Get the serial port output from a Compute Instance.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_instance_template"
description: |-
Get a VM instance template within GCE.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_lb_ip_ranges"
description: |-
Get information about the IP ranges used when health-checking load balancers.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_network"
description: |-
Get a network within GCE.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_network_endpoint_group"
description: |-
Retrieve Network Endpoint Group's details.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_network_peering"
description: |-
Get information of a specified compute network peering.
---
Expand Down Expand Up @@ -57,6 +56,6 @@ See [google_compute_network_peering](https://registry.terraform.io/providers/has
## Timeouts

This datasource provides the following
[Timeouts](/docs/configuration/resources.html#timeouts) configuration options:
[Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options: configuration options:

- `read` - Default is 4 minutes.
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_node_types"
description: |-
Provides list of available Google Compute Engine node types for
sole-tenant nodes.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_region_instance_group"
description: |-
Get the instances inside a Compute Region Instance Group within GCE.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_region_network_endpoint_group"
description: |-
Retrieve Region Network Endpoint Group's details.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_region_ssl_certificate"
description: |-
Get info about a Regional Google Compute SSL Certificate.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_regions"
description: |-
Provides a list of available Google Compute regions
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_resource_policy"
description: |-
Provide access to a Resource Policy's attributes
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_router"
description: |-
Get a Cloud Router within GCE.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
subcategory: "Compute Engine"
page_title: "Google: google_compute_router_nat"
description: |-
Get information about a Google Compute Router NAT.
---
Expand Down
Loading

0 comments on commit 62a62f2

Please sign in to comment.