Improve beta resources documentation (#436)

* 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

View file

@ -49,5 +49,9 @@ func CheckBetaResourcesEnabled(ctx context.Context, data *core.ProviderData, dia
func AddBetaDescription(description string) string {
// 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.",
)
}