Skip to content

Commit

Permalink
chore: Add preview and stable categories to resources and data source…
Browse files Browse the repository at this point in the history
…s in docs (#3370)

<!-- Feel free to delete comments as you fill this in -->
- Group stable and preview resources and data sources in docs.
- Adjust a few descriptions regarding preview status.
<!-- summary of changes -->

## Test Plan
<!-- detail ways in which this PR has been tested or needs to be tested
-->
* [ ] acceptance tests
<!-- add more below if you think they are relevant -->
* [ ] …

## References
<!-- issues documentation links, etc  -->
  • Loading branch information
sfc-gh-jmichalak authored Feb 3, 2025
1 parent 97813b6 commit b061434
Show file tree
Hide file tree
Showing 222 changed files with 231 additions and 239 deletions.
6 changes: 6 additions & 0 deletions MIGRATION_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ across different versions.
> [!TIP]
> We highly recommend upgrading the versions one by one instead of bulk upgrades.
## v1.0.2 ➞ v1.0.3

### Changed documentation structure
We added `Preview` and `Stable` categories to the resources and data sources documentation, which clearly separates the preview and stable features in the documentation feature list.
This is a part of our effort to improve the provider documentation. We are open for your feedback and suggestions.

## v1.0.1 ➞ v1.0.2

### Fixed migration of account resource
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/account_roles.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_account_roles Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
Data source used to get details of filtered account roles. Filtering is aligned with the current possibilities for SHOW ROLES https://docs.snowflake.com/en/sql-reference/sql/show-roles query (like and in_class are all supported). The results of SHOW are encapsulated in one output collection.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/accounts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_accounts Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
Data source used to get details of filtered accounts. Filtering is aligned with the current possibilities for SHOW ACCOUNTS https://docs.snowflake.com/en/sql-reference/sql/show-accounts query. The results of SHOW are encapsulated in one output collection accounts.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/alerts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_alerts Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/connections.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_connections Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
Data source used to get details of filtered connections. Filtering is aligned with the current possibilities for SHOW CONNECTIONS https://docs.snowflake.com/en/sql-reference/sql/show-connections query. The results of SHOW is encapsulated in one output collection connections.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/cortex_search_services.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_cortex_search_services Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/current_account.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_current_account Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/current_role.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_current_role Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/database.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_database Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/database_role.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_database_role Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/database_roles.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_database_roles Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
Data source used to get details of filtered database roles. Filtering is aligned with the current possibilities for SHOW DATABASE ROLES https://docs.snowflake.com/en/sql-reference/sql/show-database-roles query (like and limit are supported). The results of SHOW is encapsulated in show_output collection.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/databases.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_databases Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
Data source used to get details of filtered databases. Filtering is aligned with the current possibilities for SHOW DATABASES https://docs.snowflake.com/en/sql-reference/sql/show-databases query (like, starts_with, and limit are all supported). The results of SHOW, DESCRIBE, and SHOW PARAMETERS IN are encapsulated in one output collection.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/dynamic_tables.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_dynamic_tables Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/external_functions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_external_functions Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/external_tables.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_external_tables Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/failover_groups.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_failover_groups Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/file_formats.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_file_formats Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/functions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_functions Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/grants.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_grants Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/masking_policies.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_masking_policies Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
Data source used to get details of filtered masking policies. Filtering is aligned with the current possibilities for SHOW MASKING POLICIES https://docs.snowflake.com/en/sql-reference/sql/show-masking-policies query. The results of SHOW and DESCRIBE are encapsulated in one output collection masking_policies.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/materialized_views.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_materialized_views Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/network_policies.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_network_policies Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
Data source used to get details of filtered network policies. Filtering is aligned with the current possibilities for SHOW NETWORK POLICIES https://docs.snowflake.com/en/sql-reference/sql/show-network-policies query (like is supported). The results of SHOW and DESCRIBE are encapsulated in one output collection.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/parameters.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_parameters Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/pipes.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_pipes Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/procedures.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_procedures Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/resource_monitors.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_resource_monitors Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
Data source used to get details of filtered resource monitors. Filtering is aligned with the current possibilities for SHOW RESOURCE MONITORS https://docs.snowflake.com/en/sql-reference/sql/show-resource-monitors query (like is supported). The results of SHOW is encapsulated in show_output collection.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/row_access_policies.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_row_access_policies Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
Data source used to get details of filtered row access policies. Filtering is aligned with the current possibilities for SHOW ROW ACCESS POLICIES https://docs.snowflake.com/en/sql-reference/sql/show-row-access-policies query. The results of SHOW and DESCRIBE are encapsulated in one output collection row_access_policies.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/schemas.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_schemas Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
Data source used to get details of filtered schemas. Filtering is aligned with the current possibilities for SHOW SCHEMAS https://docs.snowflake.com/en/sql-reference/sql/show-schemas query. The results of SHOW, DESCRIBE, and SHOW PARAMETERS IN are encapsulated in one output collection.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/secrets.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_secrets Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
Data source used to get details of filtered secrets. Filtering is aligned with the current possibilities for SHOW SECRETS https://docs.snowflake.com/en/sql-reference/sql/show-secrets query. The results of SHOW and DESCRIBE are encapsulated in one output collection secrets.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/security_integrations.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_security_integrations Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
Data source used to get details of filtered security integrations. Filtering is aligned with the current possibilities for SHOW SECURITY INTEGRATIONS https://docs.snowflake.com/en/sql-reference/sql/show-integrations query (only like is supported). The results of SHOW and DESCRIBE are encapsulated in one output collection security_integrations.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/sequences.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_sequences Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/shares.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_shares Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/stages.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_stages Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/storage_integrations.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_storage_integrations Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/streamlits.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_streamlits Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
Data source used to get details of filtered streamlits. Filtering is aligned with the current possibilities for SHOW STREAMLITS https://docs.snowflake.com/en/sql-reference/sql/show-streamlits query (only like is supported). The results of SHOW and DESCRIBE are encapsulated in one output collection streamlits.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/streams.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_streams Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
Data source used to get details of filtered streams. Filtering is aligned with the current possibilities for SHOW STREAMS https://docs.snowflake.com/en/sql-reference/sql/show-streams query. The results of SHOW and DESCRIBE are encapsulated in one output collection streams.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/system_generate_scim_access_token.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_system_generate_scim_access_token Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/system_get_aws_sns_iam_policy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_system_get_aws_sns_iam_policy Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/system_get_privatelink_config.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_system_get_privatelink_config Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/system_get_snowflake_platform_info.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_system_get_snowflake_platform_info Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/tables.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_tables Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/tags.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_tags Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
Data source used to get details of filtered tags. Filtering is aligned with the current possibilities for SHOW TAGS https://docs.snowflake.com/en/sql-reference/sql/show-tags query. The results of SHOW are encapsulated in one output collection tags.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/tasks.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_tasks Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
Data source used to get details of filtered tasks. Filtering is aligned with the current possibilities for SHOW TASKS https://docs.snowflake.com/en/sql-reference/sql/show-tasks query. The results of SHOW and SHOW PARAMETERS IN are encapsulated in one output collection tasks.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/users.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_users Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
Data source used to get details of filtered users. Filtering is aligned with the current possibilities for SHOW USERS https://docs.snowflake.com/en/sql-reference/sql/show-users query. The results of SHOW, DESCRIBE, and SHOW PARAMETERS IN are encapsulated in one output collection. Important note is that when querying users you don't have permissions to, the querying options are limited. You won't get almost any field in show_output (only empty or default values), the DESCRIBE command cannot be called, so you have to set with_describe = false. Only parameters output is not affected by the lack of privileges.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/views.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_views Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
Data source used to get details of filtered views. Filtering is aligned with the current possibilities for SHOW VIEWS https://docs.snowflake.com/en/sql-reference/sql/show-views query (only like is supported). The results of SHOW and DESCRIBE are encapsulated in one output collection views.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/warehouses.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_warehouses Data Source - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
Data source used to get details of filtered warehouses. Filtering is aligned with the current possibilities for SHOW WAREHOUSES https://docs.snowflake.com/en/sql-reference/sql/show-warehouses query (only like is supported). The results of SHOW, DESCRIBE, and SHOW PARAMETERS IN are encapsulated in one output collection.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/account.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_account Resource - terraform-provider-snowflake"
subcategory: ""
subcategory: "Stable"
description: |-
The account resource allows you to create and manage Snowflake accounts. For more information, check account documentation https://docs.snowflake.com/en/user-guide/organizations-manage-accounts.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/account_authentication_policy_attachment.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
page_title: "snowflake_account_authentication_policy_attachment Resource - terraform-provider-snowflake"
subcategory: ""
subcategory: "Preview"
description: |-
Specifies the authentication policy to use for the current account. To set the authentication policy of a different account, use a provider alias.
---
Expand Down
Loading

0 comments on commit b061434

Please sign in to comment.