Standardize docs Markdown format with Markdownlint

Signed-off-by: Timo Sand <[email protected]>

Author: deiga

.markdownlint.json

@@ -0,0 +1,17 @@
+{
+  "MD004": {
+    "style": "dash"
+  },
+  "MD007": {
+    "indent": 4
+  },
+  "MD013": false,
+  "MD014": false,
+  "MD022": false,
+  "MD029": {
+    "style": "ordered"
+  },
+  "MD033": {
+    "allowed_elements": ["a"]
+  }
+}

CONTRIBUTING.md

@@ -131,7 +131,7 @@ provider_installation {
 }
 ```
 
-See <https://www.terraform.io/docs/cli/config/config-file.html> for more details.
+See [Terraform CLI Config File](https://www.terraform.io/docs/cli/config/config-file.html) for more details.
 
 When running examples, you should spot the following warning to confirm you are using a local build:
 

docs/data-sources/actions_environment_secrets.md

@@ -21,7 +21,7 @@ data "github_actions_environment_secrets" "example" {
 
 ## Attributes Reference
 
-* `secrets` - list of secrets for the environment
-  * `name` - Name of the secret
-  * `created_at` - Timestamp of the secret creation
-  * `updated_at` - Timestamp of the secret last update
+- `secrets` - list of secrets for the environment
+    - `name` - Name of the secret
+    - `created_at` - Timestamp of the secret creation
+    - `updated_at` - Timestamp of the secret last update

docs/data-sources/actions_environment_variables.md

@@ -21,8 +21,8 @@ data "github_actions_environment_variables" "example" {
 
 ## Attributes Reference
 
-* `variables` - list of variables for the environment
-  * `name` - Name of the variable
-  * `value` - Value of the variable
-  * `created_at` - Timestamp of the variable creation
-  * `updated_at` - Timestamp of the variable last update
+- `variables` - list of variables for the environment
+    - `name` - Name of the variable
+    - `value` - Value of the variable
+    - `created_at` - Timestamp of the variable creation
+    - `updated_at` - Timestamp of the variable last update

docs/data-sources/actions_organization_oidc_subject_claim_customization_template.md

@@ -19,4 +19,4 @@ data "github_actions_organization_oidc_subject_claim_customization_template" "ex
 
 ## Attributes Reference
 
-* `include_claim_keys` - The list of OpenID Connect claim keys.
+- `include_claim_keys` - The list of OpenID Connect claim keys.

docs/data-sources/actions_organization_public_key.md

@@ -16,5 +16,5 @@ data "github_actions_organization_public_key" "example" {}
 
 ## Attributes Reference
 
-* `key_id` - ID of the key that has been retrieved.
-* `key` - Actual key retrieved.
+- `key_id` - ID of the key that has been retrieved.
+- `key` - Actual key retrieved.

docs/data-sources/actions_organization_registration_token.md

@@ -19,5 +19,5 @@ data "github_actions_organization_registration_token" "example" {
 
 ## Attributes Reference
 
-* `token` - The token that has been retrieved.
-* `expires_at` - The token expiration date.
+- `token` - The token that has been retrieved.
+- `expires_at` - The token expiration date.

docs/data-sources/actions_organization_secrets.md

@@ -19,8 +19,8 @@ data "github_actions_organization_secrets" "example" {
 
 ## Attributes Reference
 
-* `secrets` - list of secrets for the repository
-  * `name` - Secret name
-  * `visibility` - Secret visibility
-  * `created_at` - Timestamp of the secret creation
-  * `updated_at` - Timestamp of the secret last update
+- `secrets` - list of secrets for the repository
+    - `name` - Secret name
+    - `visibility` - Secret visibility
+    - `created_at` - Timestamp of the secret creation
+    - `updated_at` - Timestamp of the secret last update

docs/data-sources/actions_organization_variables.md

@@ -19,9 +19,9 @@ data "github_actions_organization_variables" "example" {
 
 ## Attributes Reference
 
-* `variables` - list of variables for the repository
-  * `name` - Name of the variable
-  * `value` - Value of the variable
-  * `visibility` - Visibility of the variable
-  * `created_at` - Timestamp of the variable creation
-  * `updated_at` - Timestamp of the variable last update
+- `variables` - list of variables for the repository
+    - `name` - Name of the variable
+    - `value` - Value of the variable
+    - `visibility` - Visibility of the variable
+    - `created_at` - Timestamp of the variable creation
+    - `updated_at` - Timestamp of the variable last update

docs/data-sources/actions_public_key.md

@@ -18,9 +18,9 @@ data "github_actions_public_key" "example" {
 
 ## Argument Reference
 
-* `repository` - (Required) Name of the repository to get public key from.
+- `repository` - (Required) Name of the repository to get public key from.
 
 ## Attributes Reference
 
-* `key_id` - ID of the key that has been retrieved.
-* `key` - Actual key retrieved.
+- `key_id` - ID of the key that has been retrieved.
+- `key` - Actual key retrieved.