stackit-dev-tools/terraform-provider-stackitprivatepreview
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve beta resources documentation (#436)

Browse source 
* Improve beta resources documentation

* Improve phrasing
This commit is contained in:
João Palet 2024-06-26 17:53:32 +01:00 • committed by GitHub
parent 5b617e0676
commit fc14fd5293
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 17 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/data-sources/server_backup_schedule.md
View file

@ -4,14 +4,14 @@ page_title: "stackit_server_backup_schedule Data Source - stackit"
subcategory: "" subcategory: ""
description: |- description: |-
Server backup schedule datasource schema. Must have a region specified in the provider configuration. Server backup schedule datasource schema. Must have a region specified in the provider configuration.
!> This resource is in beta and may be subject to breaking changes in the future. Use with caution. ~> This resource is in beta and may be subject to breaking changes in the future. Use with caution. See our guide https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/guides/opting_into_beta_resources for how to opt-in to use beta resources.
--- ---
# stackit_server_backup_schedule (Data Source) # stackit_server_backup_schedule (Data Source)
Server backup schedule datasource schema. Must have a `region` specified in the provider configuration. Server backup schedule datasource schema. Must have a `region` specified in the provider configuration.
!> This resource is in beta and may be subject to breaking changes in the future. Use with caution. ~> This resource is in beta and may be subject to breaking changes in the future. Use with caution. See our [guide](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/guides/opting_into_beta_resources) for how to opt-in to use beta resources.
## Example Usage ## Example Usage

4
docs/data-sources/server_backup_schedules.md
View file

@ -4,14 +4,14 @@ page_title: "stackit_server_backup_schedules Data Source - stackit"
subcategory: "" subcategory: ""
description: |- description: |-
Server backup schedules datasource schema. Must have a region specified in the provider configuration. Server backup schedules datasource schema. Must have a region specified in the provider configuration.
!> This resource is in beta and may be subject to breaking changes in the future. Use with caution. ~> This resource is in beta and may be subject to breaking changes in the future. Use with caution. See our guide https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/guides/opting_into_beta_resources for how to opt-in to use beta resources.
--- ---
# stackit_server_backup_schedules (Data Source) # stackit_server_backup_schedules (Data Source)
Server backup schedules datasource schema. Must have a `region` specified in the provider configuration. Server backup schedules datasource schema. Must have a `region` specified in the provider configuration.
!> This resource is in beta and may be subject to breaking changes in the future. Use with caution. ~> This resource is in beta and may be subject to breaking changes in the future. Use with caution. See our [guide](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/guides/opting_into_beta_resources) for how to opt-in to use beta resources.
## Example Usage ## Example Usage

6
docs/guides/opting_into_beta_resources.md
View file

@ -36,9 +36,9 @@ export STACKIT_TF_ENABLE_BETA_RESOURCES=true
## Listing Beta Resources ## Listing Beta Resources
- `stackit_server_backup_schedule` - [`stackit_server_backup_schedule`](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/resources/server_backup_schedule)
## Listing Beta Data Sources ## Listing Beta Data Sources
- `stackit_server_backup_schedule` - [`stackit_server_backup_schedule`](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/data-sources/server_backup_schedule)
- `stackit_server_backup_schedules` - [`stackit_server_backup_schedules`](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/data-sources/server_backup_schedules)

4
docs/resources/server_backup_schedule.md
View file

@ -4,14 +4,14 @@ page_title: "stackit_server_backup_schedule Resource - stackit"
subcategory: "" subcategory: ""
description: |- description: |-
Server backup schedule resource schema. Must have a region specified in the provider configuration. Server backup schedule resource schema. Must have a region specified in the provider configuration.
!> This resource is in beta and may be subject to breaking changes in the future. Use with caution. ~> This resource is in beta and may be subject to breaking changes in the future. Use with caution. See our guide https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/guides/opting_into_beta_resources for how to opt-in to use beta resources.
--- ---
# stackit_server_backup_schedule (Resource) # stackit_server_backup_schedule (Resource)
Server backup schedule resource schema. Must have a `region` specified in the provider configuration. Server backup schedule resource schema. Must have a `region` specified in the provider configuration.
!> This resource is in beta and may be subject to breaking changes in the future. Use with caution. ~> This resource is in beta and may be subject to breaking changes in the future. Use with caution. See our [guide](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/guides/opting_into_beta_resources) for how to opt-in to use beta resources.
## Example Usage ## Example Usage

6
stackit/internal/features/beta.go
View file

@ -49,5 +49,9 @@ func CheckBetaResourcesEnabled(ctx context.Context, data *core.ProviderData, dia
func AddBetaDescription(description string) string { func AddBetaDescription(description string) string {
// Callout block: https://developer.hashicorp.com/terraform/registry/providers/docs#callouts // Callout block: https://developer.hashicorp.com/terraform/registry/providers/docs#callouts
return fmt.Sprintf("%s\n\n!> This resource is in beta and may be subject to breaking changes in the future. Use with caution.", description) return fmt.Sprintf("%s\n\n~> %s %s",
description,
"This resource is in beta and may be subject to breaking changes in the future. Use with caution.",
"See our [guide](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/guides/opting_into_beta_resources) for how to opt-in to use beta resources.",
)
} }

6
templates/guides/opting_into_beta_resources.md.tmpl
View file

@ -36,9 +36,9 @@ export STACKIT_TF_ENABLE_BETA_RESOURCES=true
## Listing Beta Resources ## Listing Beta Resources
- `stackit_server_backup_schedule` - [`stackit_server_backup_schedule`](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/resources/server_backup_schedule)
## Listing Beta Data Sources ## Listing Beta Data Sources
- `stackit_server_backup_schedule` - [`stackit_server_backup_schedule`](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/data-sources/server_backup_schedule)
- `stackit_server_backup_schedules` - [`stackit_server_backup_schedules`](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/data-sources/server_backup_schedules)