From 3e2e8e3a45cabda5de2bb86432a36dcb3b76e9cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diogo=20Ferr=C3=A3o?= Date: Tue, 25 Jun 2024 10:25:00 +0100 Subject: [PATCH] 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 --- docs/guides/opting_into_beta_resources.md | 18 +++++++----------- docs/guides/vault_secrets_manager.md | 6 +++--- .../guides/opting_into_beta_resources.md.tmpl | 18 +++++++----------- templates/guides/vault_secrets_manager.md.tmpl | 6 +++--- 4 files changed, 20 insertions(+), 28 deletions(-) diff --git a/docs/guides/opting_into_beta_resources.md b/docs/guides/opting_into_beta_resources.md index 46384b12..d4ac3c71 100644 --- a/docs/guides/opting_into_beta_resources.md +++ b/docs/guides/opting_into_beta_resources.md @@ -3,17 +3,17 @@ page_title: "Configuring Beta Resources in the STACKIT Terraform Provider" --- # Configuring Beta Resources in the STACKIT Terraform Provider -### Overview +## Overview 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. 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. -### The Process of Opting into the Beta +## The Process of Opting into the Beta To use beta resources in the STACKIT Terraform provider, you have two options: -#### Option 1: Provider Configuration +### Option 1: Provider Configuration Set the `enable_beta_resources` option in the provider configuration. This is a boolean attribute that can be either `true` or `false`. @@ -24,7 +24,7 @@ provider "stackit" { } ``` -#### Option 2: Environment Variable +### Option 2: Environment Variable Set the `STACKIT_TF_ENABLE_BETA_RESOURCES` environment variable to `"true"` or `"false"`. Other values will be ignored and will produce a warning. @@ -32,12 +32,8 @@ Set the `STACKIT_TF_ENABLE_BETA_RESOURCES` environment variable to `"true"` or ` export STACKIT_TF_ENABLE_BETA_RESOURCES=true ``` -> **Note**: **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. +-> 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. -### Listing Beta Resources +## Listing Beta Resources -Currently, there are no beta resources available. This section will be updated as new beta services are introduced. - -> **Tip**: Check back regularly or refer to the [STACKIT provider documentation](#) for the latest updates on beta resources. \ No newline at end of file +Currently, there are no beta resources available. This section will be updated as new beta services are introduced. \ No newline at end of file diff --git a/docs/guides/vault_secrets_manager.md b/docs/guides/vault_secrets_manager.md index b290a374..19f8ad60 100644 --- a/docs/guides/vault_secrets_manager.md +++ b/docs/guides/vault_secrets_manager.md @@ -3,11 +3,11 @@ page_title: "Using Vault Provider with STACKIT Secrets Manager" --- # Using Vault Provider with STACKIT Secrets Manager -### Overview +## Overview 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. -### Steps +## Steps 1. **Configure STACKIT Provider** @@ -78,6 +78,6 @@ This guide outlines the process of utilizing the HashiCorp Vault provider alongs } ``` -### Note +## Note 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. \ No newline at end of file diff --git a/templates/guides/opting_into_beta_resources.md.tmpl b/templates/guides/opting_into_beta_resources.md.tmpl index 46384b12..d4ac3c71 100644 --- a/templates/guides/opting_into_beta_resources.md.tmpl +++ b/templates/guides/opting_into_beta_resources.md.tmpl @@ -3,17 +3,17 @@ page_title: "Configuring Beta Resources in the STACKIT Terraform Provider" --- # Configuring Beta Resources in the STACKIT Terraform Provider -### Overview +## Overview 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. 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. -### The Process of Opting into the Beta +## The Process of Opting into the Beta To use beta resources in the STACKIT Terraform provider, you have two options: -#### Option 1: Provider Configuration +### Option 1: Provider Configuration Set the `enable_beta_resources` option in the provider configuration. This is a boolean attribute that can be either `true` or `false`. @@ -24,7 +24,7 @@ provider "stackit" { } ``` -#### Option 2: Environment Variable +### Option 2: Environment Variable Set the `STACKIT_TF_ENABLE_BETA_RESOURCES` environment variable to `"true"` or `"false"`. Other values will be ignored and will produce a warning. @@ -32,12 +32,8 @@ Set the `STACKIT_TF_ENABLE_BETA_RESOURCES` environment variable to `"true"` or ` export STACKIT_TF_ENABLE_BETA_RESOURCES=true ``` -> **Note**: **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. +-> 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. -### Listing Beta Resources +## Listing Beta Resources -Currently, there are no beta resources available. This section will be updated as new beta services are introduced. - -> **Tip**: Check back regularly or refer to the [STACKIT provider documentation](#) for the latest updates on beta resources. \ No newline at end of file +Currently, there are no beta resources available. This section will be updated as new beta services are introduced. \ No newline at end of file diff --git a/templates/guides/vault_secrets_manager.md.tmpl b/templates/guides/vault_secrets_manager.md.tmpl index b290a374..19f8ad60 100644 --- a/templates/guides/vault_secrets_manager.md.tmpl +++ b/templates/guides/vault_secrets_manager.md.tmpl @@ -3,11 +3,11 @@ page_title: "Using Vault Provider with STACKIT Secrets Manager" --- # Using Vault Provider with STACKIT Secrets Manager -### Overview +## Overview 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. -### Steps +## Steps 1. **Configure STACKIT Provider** @@ -78,6 +78,6 @@ This guide outlines the process of utilizing the HashiCorp Vault provider alongs } ``` -### Note +## Note 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. \ No newline at end of file