Skip to content

Commit 3e2e8e3

Browse files
DiogoFerraoDiogoFerrao
authored
Fix formatting of the beta configuration guide (#422)
* Fix formatting of the beta configuration guide * Fix note formatting * Fix headings in the vault secrets guide
1 parent 610b65f commit 3e2e8e3

File tree

4 files changed

+20
-28
lines changed

4 files changed

+20
-28
lines changed

‎docs/guides/opting_into_beta_resources.md‎

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@ page_title: "Configuring Beta Resources in the STACKIT Terraform Provider"
33
---
44
# Configuring Beta Resources in the STACKIT Terraform Provider
55

6-
### Overview
6+
## Overview
77

88
This guide explains how to opt into beta resources within the STACKIT Terraform provider. Beta resources are new services and features from STACKIT that are still in development and might not yet have a stable API.
99

1010
Opting into beta functionality allows users to experiment with new features and services before their official release, without compromising the stability of other resources and the provider itself. However, it's important to remember that beta resources may not be as stable as fully released counterparts, so use them with caution and provide feedback to help improve these services.
1111

12-
### The Process of Opting into the Beta
12+
## The Process of Opting into the Beta
1313

1414
To use beta resources in the STACKIT Terraform provider, you have two options:
1515

16-
#### Option 1: Provider Configuration
16+
### Option 1: Provider Configuration
1717

1818
Set the `enable_beta_resources` option in the provider configuration. This is a boolean attribute that can be either `true` or `false`.
1919

@@ -24,20 +24,16 @@ provider "stackit" {
2424
}
2525
```
2626

27-
#### Option 2: Environment Variable
27+
### Option 2: Environment Variable
2828

2929
Set the `STACKIT_TF_ENABLE_BETA_RESOURCES` environment variable to `"true"` or `"false"`. Other values will be ignored and will produce a warning.
3030

3131
```sh
3232
export STACKIT_TF_ENABLE_BETA_RESOURCES=true
3333
```
3434

35-
> **Note**: **The environment variable takes precedence over the provider configuration option.**
36-
>
37-
> This means that if the `STACKIT_TF_ENABLE_BETA_RESOURCES` environment variable is set to a valid value (`"true"` or `"false"`), it will override the `enable_beta_resources` option specified in the provider configuration.
35+
-> The environment variable takes precedence over the provider configuration option. This means that if the `STACKIT_TF_ENABLE_BETA_RESOURCES` environment variable is set to a valid value (`"true"` or `"false"`), it will override the `enable_beta_resources` option specified in the provider configuration.
3836

39-
### Listing Beta Resources
37+
## Listing Beta Resources
4038

41-
Currently, there are no beta resources available. This section will be updated as new beta services are introduced.
42-
43-
> **Tip**: Check back regularly or refer to the [STACKIT provider documentation](#) for the latest updates on beta resources.
39+
Currently, there are no beta resources available. This section will be updated as new beta services are introduced.

‎docs/guides/vault_secrets_manager.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ page_title: "Using Vault Provider with STACKIT Secrets Manager"
33
---
44
# Using Vault Provider with STACKIT Secrets Manager
55

6-
### Overview
6+
## Overview
77

88
This guide outlines the process of utilizing the HashiCorp Vault provider alongside the STACKIT provider to write secrets in the STACKIT Secrets Manager. The guide focuses on secrets from STACKIT Cloud resources but can be adapted for any secret.
99

10-
### Steps
10+
## Steps
1111

1212
1. **Configure STACKIT Provider**
1313

@@ -78,6 +78,6 @@ This guide outlines the process of utilizing the HashiCorp Vault provider alongs
7878
}
7979
```
8080
81-
### Note
81+
## Note
8282
8383
This example can be adapted for various resources within the provider as well as any other Secret the user wants to set in the Secrets Manager instance. Adapting this examples means replacing the Argus Monitoring Grafana password with the appropriate value.

‎templates/guides/opting_into_beta_resources.md.tmpl‎

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@ page_title: "Configuring Beta Resources in the STACKIT Terraform Provider"
33
---
44
# Configuring Beta Resources in the STACKIT Terraform Provider
55

6-
### Overview
6+
## Overview
77

88
This guide explains how to opt into beta resources within the STACKIT Terraform provider. Beta resources are new services and features from STACKIT that are still in development and might not yet have a stable API.
99

1010
Opting into beta functionality allows users to experiment with new features and services before their official release, without compromising the stability of other resources and the provider itself. However, it's important to remember that beta resources may not be as stable as fully released counterparts, so use them with caution and provide feedback to help improve these services.
1111

12-
### The Process of Opting into the Beta
12+
## The Process of Opting into the Beta
1313

1414
To use beta resources in the STACKIT Terraform provider, you have two options:
1515

16-
#### Option 1: Provider Configuration
16+
### Option 1: Provider Configuration
1717

1818
Set the `enable_beta_resources` option in the provider configuration. This is a boolean attribute that can be either `true` or `false`.
1919

@@ -24,20 +24,16 @@ provider "stackit" {
2424
}
2525
```
2626

27-
#### Option 2: Environment Variable
27+
### Option 2: Environment Variable
2828

2929
Set the `STACKIT_TF_ENABLE_BETA_RESOURCES` environment variable to `"true"` or `"false"`. Other values will be ignored and will produce a warning.
3030

3131
```sh
3232
export STACKIT_TF_ENABLE_BETA_RESOURCES=true
3333
```
3434

35-
> **Note**: **The environment variable takes precedence over the provider configuration option.**
36-
>
37-
> This means that if the `STACKIT_TF_ENABLE_BETA_RESOURCES` environment variable is set to a valid value (`"true"` or `"false"`), it will override the `enable_beta_resources` option specified in the provider configuration.
35+
-> The environment variable takes precedence over the provider configuration option. This means that if the `STACKIT_TF_ENABLE_BETA_RESOURCES` environment variable is set to a valid value (`"true"` or `"false"`), it will override the `enable_beta_resources` option specified in the provider configuration.
3836

39-
### Listing Beta Resources
37+
## Listing Beta Resources
4038

41-
Currently, there are no beta resources available. This section will be updated as new beta services are introduced.
42-
43-
> **Tip**: Check back regularly or refer to the [STACKIT provider documentation](#) for the latest updates on beta resources.
39+
Currently, there are no beta resources available. This section will be updated as new beta services are introduced.

‎templates/guides/vault_secrets_manager.md.tmpl‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ page_title: "Using Vault Provider with STACKIT Secrets Manager"
33
---
44
# Using Vault Provider with STACKIT Secrets Manager
55

6-
### Overview
6+
## Overview
77

88
This guide outlines the process of utilizing the HashiCorp Vault provider alongside the STACKIT provider to write secrets in the STACKIT Secrets Manager. The guide focuses on secrets from STACKIT Cloud resources but can be adapted for any secret.
99

10-
### Steps
10+
## Steps
1111

1212
1. **Configure STACKIT Provider**
1313

@@ -78,6 +78,6 @@ This guide outlines the process of utilizing the HashiCorp Vault provider alongs
7878
}
7979
```
8080

81-
### Note
81+
## Note
8282

8383
This example can be adapted for various resources within the provider as well as any other Secret the user wants to set in the Secrets Manager instance. Adapting this examples means replacing the Argus Monitoring Grafana password with the appropriate value.

0 commit comments

Comments
 (0)