Skip to content

Commit

Permalink
chore: Add few documentation adjustments (#2789)
Browse files Browse the repository at this point in the history
- Added note about integration in pipes, because of #2785
- Adjusted account **note** and **warning** to have a proper structure
(right now the docs are not treating **note** and **warning** as they
should be: [current note and
warning](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/account),
and [how they should look
like](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/grant_privileges_to_account_role))
  • Loading branch information
sfc-gh-jcieslak committed May 10, 2024
1 parent 57ee66b commit 6db8bf3
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/resources/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ description: |-

The account resource allows you to create and manage Snowflake accounts.

**WARNING** This resource cannot be destroyed!!! The only way to delete accounts is to go through [Snowflake Support](https://docs.snowflake.com/en/user-guide/organizations-manage-accounts.html#deleting-an-account)
!> **Warning** This resource cannot be destroyed!!! The only way to delete accounts is to go through [Snowflake Support](https://docs.snowflake.com/en/user-guide/organizations-manage-accounts.html#deleting-an-account)

**NOTE** ORGADMIN priviliges are required for this resource
~> **Note** ORGADMIN priviliges are required for this resource

## Example Usage

Expand Down
3 changes: 3 additions & 0 deletions docs/resources/pipe.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "snowflake_pipe Resource - terraform-provider-snowflake"
subcategory: ""
description: |-
Expand All @@ -7,6 +8,8 @@ description: |-

# snowflake_pipe (Resource)

~> **Note** Right now, changes for the `integration` field are not detected. This will be resolved in the [upcoming refactoring](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/ROADMAP.md#preparing-essential-ga-objects-for-the-provider-v1). For now, please try to use the [replace_triggered_by](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#replace_triggered_by) HCL meta-argument.



## Example Usage
Expand Down
4 changes: 2 additions & 2 deletions templates/resources/account.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ description: |-

{{ .Description | trimspace }}

**WARNING** This resource cannot be destroyed!!! The only way to delete accounts is to go through [Snowflake Support](https://docs.snowflake.com/en/user-guide/organizations-manage-accounts.html#deleting-an-account)
!> **Warning** This resource cannot be destroyed!!! The only way to delete accounts is to go through [Snowflake Support](https://docs.snowflake.com/en/user-guide/organizations-manage-accounts.html#deleting-an-account)

**NOTE** ORGADMIN priviliges are required for this resource
~> **Note** ORGADMIN priviliges are required for this resource

## Example Usage

Expand Down
33 changes: 33 additions & 0 deletions templates/resources/pipe.md.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
subcategory: ""
description: |-
{{ if gt (len (split .Description "<deprecation>")) 1 -}}
{{ index (split .Description "<deprecation>") 1 | plainmarkdown | trimspace | prefixlines " " }}
{{- else -}}
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
{{- end }}
---

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

~> **Note** Right now, changes for the `integration` field are not detected. This will be resolved in the [upcoming refactoring](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/ROADMAP.md#preparing-essential-ga-objects-for-the-provider-v1). For now, please try to use the [replace_triggered_by](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#replace_triggered_by) HCL meta-argument.

{{ .Description | trimspace }}

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

{{ tffile (printf "examples/resources/%s/resource.tf" .Name)}}
{{- end }}

{{ .SchemaMarkdown | trimspace }}
{{- if .HasImport }}

## Import

Import is supported using the following syntax:

{{ codefile "shell" (printf "examples/resources/%s/import.sh" .Name)}}
{{- end }}

0 comments on commit 6db8bf3

Please sign in to comment.