Skip to content

Commit

Permalink
Fix Data Warehouse documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Viktor Csomor committed Nov 21, 2024
1 parent b0169cb commit a2392cc
Show file tree
Hide file tree
Showing 11 changed files with 92 additions and 14 deletions.
5 changes: 1 addition & 4 deletions docs/resources/dw_aws_cluster.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "cdp_dw_aws_cluster Resource - terraform-provider-cdp"
subcategory: ""
subcategory: "Data Warehouse"
description: |-
Creates an AWS Data Warehouse cluster.
---
Expand Down Expand Up @@ -134,5 +133,3 @@ Optional:
- `async` (Boolean) Boolean value that specifies if Terraform should wait for resource creation/deletion.
- `call_failure_threshold` (Number) Threshold value that specifies how many times should a single call failure happen before giving up the polling.
- `polling_timeout` (Number) Timeout value in minutes that specifies for how long should the polling go for resource creation/deletion.


5 changes: 1 addition & 4 deletions docs/resources/dw_database_catalog.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "cdp_dw_database_catalog Resource - terraform-provider-cdp"
subcategory: ""
subcategory: "Data Warehouse"
description: |-
Creates an AWS Data Warehouse database catalog.
---
Expand Down Expand Up @@ -38,5 +37,3 @@ Optional:
- `async` (Boolean) Boolean value that specifies if Terraform should wait for resource creation/deletion.
- `call_failure_threshold` (Number) Threshold value that specifies how many times should a single call failure happen before giving up the polling.
- `polling_timeout` (Number) Timeout value in minutes that specifies for how long should the polling go for resource creation/deletion.


4 changes: 4 additions & 0 deletions docs/resources/dw_vw_hive.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
page_title: "<no value> <no value> - <no value>"
subcategory: "Data Warehouse"
description: |-
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
# OF ANY KIND, either express or implied. Refer to the License for the specific
# permissions and limitations governing your use of the file.

resource "cdp_vw_hive" "example" {
resource "cdp_dw_vw_hive" "example" {
cluster_id = var.cluster_id
database_catalog_id = var.database_catalog_id
name = var.name
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
# permissions and limitations governing your use of the file.

resource "cdp_environments_aws_credential" "example" {
credential_name = "example-cdp-aws-credential"
role_arn = "arn:aws:iam::11111111111:role/example-cross-account-role"
description = "Example AWS Credentials"
credential_name = "example-cdp-aws-credential"
role_arn = "arn:aws:iam::11111111111:role/example-cross-account-role"
description = "Example AWS Credentials"
skip_org_policy_decisions = false
verify_permissions = false
verify_permissions = false
}

output "credential_name" {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ import (
)

var testHiveSchema = schema.Schema{
MarkdownDescription: "A Hive Virtual Warehouse is service which is able to run big SQL queries.",
Attributes: map[string]schema.Attribute{
"id": schema.StringAttribute{
Computed: true,
Expand Down
1 change: 1 addition & 0 deletions resources/dw/virtualwarehouse/hive/schema_hive_vw.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (
)

var hiveSchema = schema.Schema{
MarkdownDescription: "A Hive Virtual Warehouse is service which is able to run big SQL queries.",
Attributes: map[string]schema.Attribute{
"id": schema.StringAttribute{
Computed: true,
Expand Down
26 changes: 26 additions & 0 deletions templates/resources/dw_aws_cluster.md.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
subcategory: "Data Warehouse"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

# {{.Name}} ({{.Type}})

{{ .Description | trimspace }}

{{ if .HasExample -}}
## Example Usage

{{ tffile .ExampleFile }}
{{- end }}

{{ .SchemaMarkdown | trimspace }}

{{- if .HasImport }}
## Import

Import is supported using the following syntax:

{{codefile "shell" .ImportFile }}
{{- end }}
26 changes: 26 additions & 0 deletions templates/resources/dw_database_catalog.md.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
subcategory: "Data Warehouse"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

# {{.Name}} ({{.Type}})

{{ .Description | trimspace }}

{{ if .HasExample -}}
## Example Usage

{{ tffile .ExampleFile }}
{{- end }}

{{ .SchemaMarkdown | trimspace }}

{{- if .HasImport }}
## Import

Import is supported using the following syntax:

{{codefile "shell" .ImportFile }}
{{- end }}
26 changes: 26 additions & 0 deletions templates/resources/dw_vw_hive.md.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
subcategory: "Data Warehouse"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

# {{.Name}} ({{.Type}})

{{ .Description | trimspace }}

{{ if .HasExample -}}
## Example Usage

{{ tffile .ExampleFile }}
{{- end }}

{{ .SchemaMarkdown | trimspace }}

{{- if .HasImport }}
## Import

Import is supported using the following syntax:

{{codefile "shell" .ImportFile }}
{{- end }}
2 changes: 1 addition & 1 deletion templates/resources/iam_group.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ description: |-
Import is supported using the following syntax:

{{codefile "shell" .ImportFile }}
{{- end }}
{{- end }}

0 comments on commit a2392cc

Please sign in to comment.