-
Notifications
You must be signed in to change notification settings - Fork 420
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Add few documentation adjustments (#2789)
- 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
1 parent
57ee66b
commit 6db8bf3
Showing
4 changed files
with
40 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 }} |