Merge pull request #298 from Scalr/fix/docs

Fix Data-source / Resource headers and alerts.
Scalr · Jan 19, 2024 · 0281af5 · 0281af5
2 parents 42e20c5 + d03aacf
commit 0281af5
Show file tree

Hide file tree

Showing 61 changed files with 69 additions and 68 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 
 - `scalr_policy_group`: fixed unexpected unlinking of environments from policy group on re-run ([#297](https://github.com/Scalr/terraform-provider-scalr/pull/297))
+- fixed the data-source / resource headers and alerts.
 
 ## [1.7.0] - 2023-12-22
 

diff --git a/docs/data-sources/access_policy.md b/docs/data-sources/access_policy.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 1
 ---
-## Data Source Overview
+## Data Source: scalr_access_policy
 
 This data source is used to retrieve details of a single access policy by id.
 

diff --git a/docs/data-sources/agent_pool.md b/docs/data-sources/agent_pool.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 2
 ---
-## Data Source Overview
+## Data Source: scalr_agent_pool
 
 Retrieves the details of an agent pool.
 

diff --git a/docs/data-sources/current_account.md b/docs/data-sources/current_account.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 3
 ---
-## Data Source Overview
+## Data Source: scalr_current_account
 
 Retrieves the details of current account when using Scalr remote backend.
 

diff --git a/docs/data-sources/current_run.md b/docs/data-sources/current_run.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 4
 ---
-## Data Source Overview
+## Data Source: scalr_current_run
 
 Allows you to get information about the current Terraform run when using a Scalr remote backend workspace, including VCS (Git) metadata.
 

diff --git a/docs/data-sources/endpoint.md b/docs/data-sources/endpoint.md
@@ -6,11 +6,11 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 5
 ---
-## Data Source Overview
+## Data Source: scalr_endpoint
 
 Retrieves the details of a webhook endpoint.
 
-> 🚧 This datasource is deprecated and will be removed in the next major version.
+!> **Warning** This datasource is deprecated and will be removed in the next major version.
 
 ## Example Usage
 

diff --git a/docs/data-sources/environment.md b/docs/data-sources/environment.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 6
 ---
-## Data Source Overview
+## Data Source: scalr_environment
 
 Retrieves the details of a Scalr environment.
 

diff --git a/docs/data-sources/environments.md b/docs/data-sources/environments.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 7
 ---
-## Data Source Overview
+## Data Source: scalr_environments
 
 Retrieves a list of environment ids by name or tags.
 

diff --git a/docs/data-sources/iam_team.md b/docs/data-sources/iam_team.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 8
 ---
-## Data Source Overview
+## Data Source: scalr_iam_team
 
 Retrieves the details of a Scalr team.
 

diff --git a/docs/data-sources/iam_user.md b/docs/data-sources/iam_user.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 9
 ---
-## Data Source Overview
+## Data Source: scalr_iam_user
 
 Retrieves the details of a Scalr user.
 

diff --git a/docs/data-sources/module_version.md b/docs/data-sources/module_version.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 10
 ---
-## Data Source Overview
+## Data Source: scalr_module_version
 
 Retrieves the module version data by module source and semantic version.
 

diff --git a/docs/data-sources/policy_group.md b/docs/data-sources/policy_group.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 11
 ---
-## Data Source Overview
+## Data Source: scalr_policy_group
 
 Retrieves the details of a policy group.
 

diff --git a/docs/data-sources/provider_configuration.md b/docs/data-sources/provider_configuration.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 12
 ---
-## Data Source Overview
+## Data Source: scalr_provider_configuration
 
 Retrieves information about a single provider configuration.
 

diff --git a/docs/data-sources/provider_configurations.md b/docs/data-sources/provider_configurations.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 13
 ---
-## Data Source Overview
+## Data Source: scalr_provider_configurations
 
 Retrieves a list of provider configuration ids by name or type.
 

diff --git a/docs/data-sources/role.md b/docs/data-sources/role.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 14
 ---
-## Data Source Overview
+## Data Source: scalr_role
 
 This data source is used to retrieve details of a single role.
 

diff --git a/docs/data-sources/service_account.md b/docs/data-sources/service_account.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 15
 ---
-## Data Source Overview
+## Data Source: scalr_service_account
 
 Retrieves information about a service account.
 

diff --git a/docs/data-sources/tag.md b/docs/data-sources/tag.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 16
 ---
-## Data Source Overview
+## Data Source: scalr_tag
 
 Retrieves information about a tag.
 

diff --git a/docs/data-sources/variable.md b/docs/data-sources/variable.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 17
 ---
-## Data Source Overview
+## Data Source: scalr_variable
 
 Retrieves the details of a variable.
 

diff --git a/docs/data-sources/variables.md b/docs/data-sources/variables.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 18
 ---
-## Data Source Overview
+## Data Source: scalr_variables
 
 Retrieves the list of variables by the given filters.
 

diff --git a/docs/data-sources/vcs_provider.md b/docs/data-sources/vcs_provider.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 19
 ---
-## Data Source Overview
+## Data Source: scalr_vcs_provider
 
 Retrieves the details of a VCS provider.
 

diff --git a/docs/data-sources/webhook.md b/docs/data-sources/webhook.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 20
 ---
-## Data Source Overview
+## Data Source: scalr_webhook
 
 Retrieves the details of a webhook.
 

diff --git a/docs/data-sources/workspace.md b/docs/data-sources/workspace.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 21
 ---
-## Data Source Overview
+## Data Source: scalr_workspace
 
 Retrieves the details of a single workspace.
 

diff --git a/docs/data-sources/workspace_ids.md b/docs/data-sources/workspace_ids.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 22
 ---
-## Data Source Overview
+## Data Source: scalr_workspace_ids
 
 Retrieves a map of workspace IDs based on the names provided. Wildcards are accepted.
 

diff --git a/docs/data-sources/workspaces.md b/docs/data-sources/workspaces.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_datasources"
 hidden: false
 order: 23
 ---
-## Data Source Overview
+## Data Source: scalr_workspaces
 
 Retrieves a list of workspace ids by name or tags.
 

diff --git a/docs/resources/access_policy.md b/docs/resources/access_policy.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_resources"
 hidden: false
 order: 1
 ---
-## Resource Overview
+## Resource: scalr_access_policy
 
 Manages the Scalr IAM access policies. Create, update and destroy.
 

diff --git a/docs/resources/account_allowed_ips.md b/docs/resources/account_allowed_ips.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_resources"
 hidden: false
 order: 2
 ---
-## Resource Overview
+## Resource: scalr_account_allowed_ips
 
 Manages the list of allowed IPs for an account in Scalr. Create, update and destroy.
 

diff --git a/docs/resources/agent_pool.md b/docs/resources/agent_pool.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_resources"
 hidden: false
 order: 3
 ---
-## Resource Overview
+## Resource: scalr_agent_pool
 
 Manage the state of agent pools in Scalr. Create, update and destroy.
 

diff --git a/docs/resources/agent_pool_token.md b/docs/resources/agent_pool_token.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_resources"
 hidden: false
 order: 4
 ---
-## Resource Overview
+## Resource: scalr_agent_pool_token
 
 Manage the state of agent pool's tokens in Scalr. Create, update and destroy.
 

diff --git a/docs/resources/endpoint.md b/docs/resources/endpoint.md
@@ -6,11 +6,11 @@ parentDocSlug: "provider_resources"
 hidden: false
 order: 5
 ---
-## Resource Overview
+## Resource: scalr_endpoint
 
 Manage the state of endpoints in Scalr. Create, update and destroy.
 
-> 🚧 This resource is deprecated and will be removed in the next major version.
+!> **Warning** This resource is deprecated and will be removed in the next major version.
 
 ## Example Usage
 

diff --git a/docs/resources/environment.md b/docs/resources/environment.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_resources"
 hidden: false
 order: 6
 ---
-## Resource Overview
+## Resource: scalr_environment
 
 Manage the state of environments in Scalr. Creates, updates and destroys.
 

diff --git a/docs/resources/iam_team.md b/docs/resources/iam_team.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_resources"
 hidden: false
 order: 7
 ---
-## Resource Overview
+## Resource: scalr_iam_team
 
 Manages the Scalr IAM teams: performs create, update and destroy actions.
 

diff --git a/docs/resources/module.md b/docs/resources/module.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_resources"
 hidden: false
 order: 8
 ---
-## Resource Overview
+## Resource: scalr_module
 
 Manages the state of a module in the Private Modules Registry. Create and destroy operations are available only.
 

diff --git a/docs/resources/policy_group.md b/docs/resources/policy_group.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_resources"
 hidden: false
 order: 9
 ---
-## Resource Overview
+## Resource: scalr_policy_group
 
 Manage the state of policy groups in Scalr. Create, update and destroy.
 
@@ -38,7 +38,7 @@ resource "scalr_policy_group" "example" {
 ### Optional
 
 - `account_id` (String) The identifier of the Scalr account, in the format `acc-<RANDOM STRING>`.
-- `environments` (List of String) A list of the environments the policy group is linked to. Use `["*"]` to enforce in all environments. To manage a linkage use either this attribute or `scalr_policy_group_linkage` resource.
+- `environments` (List of String) A list of the environments the policy group is linked to. Use `["*"]` to enforce in all environments. To manage a linkage use either this attribute or the `scalr_policy_group_linkage` resource.
 - `opa_version` (String) The version of Open Policy Agent to run policies against. If omitted, the system default version is assigned.
 
 ### Read-Only

diff --git a/docs/resources/policy_group_linkage.md b/docs/resources/policy_group_linkage.md
@@ -6,11 +6,11 @@ parentDocSlug: "provider_resources"
 hidden: false
 order: 10
 ---
-## Resource Overview
+## Resource: scalr_policy_group_linkage
 
 Manage policy group to environment linking in Scalr. Create, update and destroy.
 
-**Note:** To manage a linkage use either this resource or `environments` attribute of [`scalr_policy_group`](provider_resource_scalr_policy_group) resource.
+-> **Note** To manage a linkage use either this resource or the `environments` attribute of the [`scalr_policy_group`](provider_resource_scalr_policy_group) resource.
 
 ## Example Usage
 

diff --git a/docs/resources/provider_configuration.md b/docs/resources/provider_configuration.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_resources"
 hidden: false
 order: 11
 ---
-## Resource Overview
+## Resource: scalr_provider_configuration
 
 A provider configuration helps organizations manage provider secrets in a centralized way. It natively supports the management of the major providers like Scalr, AWS, AzureRM, and Google Cloud Platform, but also allows registering any custom provider. Please have a look at the basic usage examples for each provider type.
 

diff --git a/docs/resources/provider_configuration_default.md b/docs/resources/provider_configuration_default.md
@@ -6,11 +6,11 @@ parentDocSlug: "provider_resources"
 hidden: false
 order: 12
 ---
-## Resource Overview
+## Resource: scalr_provider_configuration_default
 
 Manage defaults of provider configurations for environments in Scalr. Create and destroy.
 
-**Note:** To make the provider configuration default, it must be shared with the specified environment. See the definition of the resource [`scalr_provider_configuration`](provider_resource_scalr_provider_configuration) and attribute `environments` to learn more.
+-> **Note** To make the provider configuration default, it must be shared with the specified environment. See the definition of the resource [`scalr_provider_configuration`](provider_resource_scalr_provider_configuration) and attribute `environments` to learn more.
 
 ## Example Usage
 

diff --git a/docs/resources/role.md b/docs/resources/role.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_resources"
 hidden: false
 order: 13
 ---
-## Resource Overview
+## Resource: scalr_role
 
 Manage the Scalr IAM roles. Create, update and destroy.
 

diff --git a/docs/resources/run_trigger.md b/docs/resources/run_trigger.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_resources"
 hidden: false
 order: 14
 ---
-## Resource Overview
+## Resource: scalr_run_trigger
 
 Run triggers are a way to chain workspaces together. The use case for this is that you might have one or more upstream workspaces that need to automatically kick off a downstream workspace based on a successful run in the upstream workspace. To set a trigger, go to the downstream workspace and set the upstream workspace(s). Now, whenever the upstream workspace has a successful run, the downstream workspace will automatically start a run.
 

diff --git a/docs/resources/service_account.md b/docs/resources/service_account.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_resources"
 hidden: false
 order: 15
 ---
-## Resource Overview
+## Resource: scalr_service_account
 
 Manages the state of service accounts in Scalr.
 

diff --git a/docs/resources/service_account_token.md b/docs/resources/service_account_token.md
@@ -6,7 +6,7 @@ parentDocSlug: "provider_resources"
 hidden: false
 order: 16
 ---
-## Resource Overview
+## Resource: scalr_service_account_token
 
 Manage the state of service account's tokens in Scalr. Create, update and destroy.