Skip to content

Commit fc14fd5

Browse files
authored
Improve beta resources documentation (#436)
* Improve beta resources documentation * Improve phrasing
1 parent 5b617e0 commit fc14fd5

File tree

6 files changed

+17
-13
lines changed

6 files changed

+17
-13
lines changed

docs/data-sources/server_backup_schedule.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ page_title: "stackit_server_backup_schedule Data Source - stackit"
44
subcategory: ""
55
description: |-
66
Server backup schedule datasource schema. Must have a region specified in the provider configuration.
7-
!> This resource is in beta and may be subject to breaking changes in the future. Use with caution.
7+
~> 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.
88
---
99

1010
# stackit_server_backup_schedule (Data Source)
1111

1212
Server backup schedule datasource schema. Must have a `region` specified in the provider configuration.
1313

14-
!> This resource is in beta and may be subject to breaking changes in the future. Use with caution.
14+
~> 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.
1515

1616
## Example Usage
1717

docs/data-sources/server_backup_schedules.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ page_title: "stackit_server_backup_schedules Data Source - stackit"
44
subcategory: ""
55
description: |-
66
Server backup schedules datasource schema. Must have a region specified in the provider configuration.
7-
!> This resource is in beta and may be subject to breaking changes in the future. Use with caution.
7+
~> 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.
88
---
99

1010
# stackit_server_backup_schedules (Data Source)
1111

1212
Server backup schedules datasource schema. Must have a `region` specified in the provider configuration.
1313

14-
!> This resource is in beta and may be subject to breaking changes in the future. Use with caution.
14+
~> 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.
1515

1616
## Example Usage
1717

docs/guides/opting_into_beta_resources.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ export STACKIT_TF_ENABLE_BETA_RESOURCES=true
3636

3737
## Listing Beta Resources
3838

39-
- `stackit_server_backup_schedule`
39+
- [`stackit_server_backup_schedule`](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/resources/server_backup_schedule)
4040

4141
## Listing Beta Data Sources
4242

43-
- `stackit_server_backup_schedule`
44-
- `stackit_server_backup_schedules`
43+
- [`stackit_server_backup_schedule`](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/data-sources/server_backup_schedule)
44+
- [`stackit_server_backup_schedules`](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/data-sources/server_backup_schedules)

docs/resources/server_backup_schedule.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ page_title: "stackit_server_backup_schedule Resource - stackit"
44
subcategory: ""
55
description: |-
66
Server backup schedule resource schema. Must have a region specified in the provider configuration.
7-
!> This resource is in beta and may be subject to breaking changes in the future. Use with caution.
7+
~> 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.
88
---
99

1010
# stackit_server_backup_schedule (Resource)
1111

1212
Server backup schedule resource schema. Must have a `region` specified in the provider configuration.
1313

14-
!> This resource is in beta and may be subject to breaking changes in the future. Use with caution.
14+
~> 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.
1515

1616
## Example Usage
1717

stackit/internal/features/beta.go

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,5 +49,9 @@ func CheckBetaResourcesEnabled(ctx context.Context, data *core.ProviderData, dia
4949

5050
func AddBetaDescription(description string) string {
5151
// Callout block: https://developer.hashicorp.com/terraform/registry/providers/docs#callouts
52-
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)
52+
return fmt.Sprintf("%s\n\n~> %s %s",
53+
description,
54+
"This resource is in beta and may be subject to breaking changes in the future. Use with caution.",
55+
"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.",
56+
)
5357
}

templates/guides/opting_into_beta_resources.md.tmpl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ export STACKIT_TF_ENABLE_BETA_RESOURCES=true
3636

3737
## Listing Beta Resources
3838

39-
- `stackit_server_backup_schedule`
39+
- [`stackit_server_backup_schedule`](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/resources/server_backup_schedule)
4040

4141
## Listing Beta Data Sources
4242

43-
- `stackit_server_backup_schedule`
44-
- `stackit_server_backup_schedules`
43+
- [`stackit_server_backup_schedule`](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/data-sources/server_backup_schedule)
44+
- [`stackit_server_backup_schedules`](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/data-sources/server_backup_schedules)

0 commit comments

Comments
 (0)