tf provider documentation update

lornest · Oct 16, 2024 · cd2594f · cd2594f
1 parent a6f5a63
commit cd2594f
Show file tree

Hide file tree

Showing 35 changed files with 393 additions and 96 deletions.
diff --git a/docs/data-sources/sonarqube_group.md b/docs/data-sources/sonarqube_group.md
@@ -1,4 +1,11 @@
-# Data Source: sonarqube_group
+---
+page_title: "sonarqube_group Data Source - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Use this data source to get a Sonarqube Group resource
+---
+
+# sonarqube_group (Data Source)
 
 Use this data source to get a Sonarqube Group resource
 
@@ -10,7 +17,6 @@ data "sonarqube_group" "group" {
 }
 ```
 
-
 ## Argument Reference
 
 The following arguments are supported:

diff --git a/docs/data-sources/sonarqube_portfolio.md b/docs/data-sources/sonarqube_portfolio.md
@@ -1,4 +1,11 @@
-# Data Source: sonarqube_portfolio
+---
+page_title: "sonarqube_portfolio Data Source - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Use this data source to get a Sonarqube portfolio resource
+---
+
+# sonarqube_portfolio (Data Source)
 
 Use this data source to get a Sonarqube portfolio resource
 
@@ -24,7 +31,7 @@ The following attributes are exported:
 - description - Description of the portfolio
 - qualifier - `VW` (portfolios always have this qualifier)
 - visibility - Portfolio visibility
-- selection_mode - How the Portfolio is populated. Possible values are ``NONE``, ``MANUAL``, ``TAGS``, ``REGEXP`` or ``REST``. [See docs](https://docs.sonarqube.org/9.8/project-administration/managing-portfolios/#populating-portfolios) for how Portfolio population works
+- selection_mode - How the Portfolio is populated. Possible values are `NONE`, `MANUAL`, `TAGS`, `REGEXP` or `REST`. [See docs](https://docs.sonarqube.org/9.8/project-administration/managing-portfolios/#populating-portfolios) for how Portfolio population works
 - branch - Which branch is analyzed
 - tags - The list of tags used to populate the Portfolio. Only active when `selection_mode` is `TAGS`
-- regexp - The regular expression used to populate the portfolio. Only active when `selection_mode` is `REGEXP`
+- regexp - The regular expression used to populate the portfolio. Only active when `selection_mode` is `REGEXP`
diff --git a/docs/data-sources/sonarqube_project.md b/docs/data-sources/sonarqube_project.md
@@ -1,4 +1,11 @@
-# Data Source: sonarqube_project
+---
+page_title: "sonarqube_project Data Source - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Use this data source to get a Sonarqube project resource
+---
+
+# sonarqube_project (Data Source)
 
 Use this data source to get a Sonarqube project resource
 
@@ -22,4 +29,4 @@ The following attributes are exported:
 
 - name - Name of the project
 - project - Key of the project
-- visibility - Project visibility
+- visibility - Project visibility
diff --git a/docs/data-sources/sonarqube_qualitygate.md b/docs/data-sources/sonarqube_qualitygate.md
@@ -1,4 +1,11 @@
-# Data Source: sonarqube_qualitygate
+---
+page_title: "sonarqube_qualitygate Data Source - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Use this data source to get a Sonarqube qualitygate resource
+---
+
+# sonarqube_qualitygate (Data Source)
 
 Use this data source to get a Sonarqube qualitygate resource
 
@@ -20,7 +27,7 @@ The following arguments are supported:
 
 The following attributes are exported:
 
-- name       - The name of the Quality Gate.
-- copy_from  - Origin of Quality Gate.
+- name - The name of the Quality Gate.
+- copy_from - Origin of Quality Gate.
 - is_default - Quality Gate default.
-- condition  - List of Quality Gate conditions.
+- condition - List of Quality Gate conditions.
diff --git a/docs/data-sources/sonarqube_qualityprofile.md b/docs/data-sources/sonarqube_qualityprofile.md
@@ -1,4 +1,11 @@
-# Data Source: sonarqube_qualityprofile
+---
+page_title: "sonarqube_qualityprofile Data Source - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Use this data source to get a Sonarqube qualityprofile resource
+---
+
+# sonarqube_qualityprofile (Data Source)
 
 Use this data source to get a Sonarqube qualityprofile resource
 
@@ -20,6 +27,6 @@ The following arguments are supported:
 
 The following attributes are exported:
 
-- name     - The name of the Quality Profile
-- language -  Quality profile language.
+- name - The name of the Quality Profile
+- language - Quality profile language.
 - is_default - Quality Profile default
diff --git a/docs/data-sources/sonarqube_rule.md b/docs/data-sources/sonarqube_rule.md
@@ -1,4 +1,11 @@
-# Data Source: sonarqube_rule
+---
+page_title: "sonarqube_rule Data Source - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Use this data source to get a Sonarqube rule resource
+---
+
+# sonarqube_rule (Data Source)
 
 Use this data source to get a Sonarqube rule resource
 
@@ -25,4 +32,4 @@ The following attributes are exported:
 - severity - Rule severity
 - status - Rule status
 - template_key - Key of the template rule
-- type - Rule type
+- type - Rule type
diff --git a/docs/data-sources/sonarqube_user.md b/docs/data-sources/sonarqube_user.md
@@ -1,4 +1,11 @@
-# Data Source: sonarqube_user
+---
+page_title: "sonarqube_user Data Source - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Use this data source to get a Sonarqube User resource
+---
+
+# sonarqube_user (Data Source)
 
 Use this data source to get a Sonarqube User resource
 
@@ -10,7 +17,6 @@ data "sonarqube_user" "user" {
 }
 ```
 
-
 ## Argument Reference
 
 The following arguments are supported:
@@ -23,4 +29,4 @@ The following attributes are exported:
 
 - id - The ID of the User.
 - login_name - The login name of the user
-- email - The users email.
+- email - The users email.
diff --git a/docs/index.md b/docs/index.md
@@ -1,8 +1,15 @@
+---
+page_title: "Sonarqube Provider"
+subcategory: ""
+description: |-
+---
+
 # Provider configuration
 
 The sonarqube provider is used to configure sonarqube. The provider needs to be configured with a url, and either with user and password or token.
 
 ## Example: Authenticate with username and password
+
 ```terraform
 terraform {
   required_providers {
@@ -14,12 +21,13 @@ terraform {
 
 provider "sonarqube" {
     user   = "admin"
-    pass   = "admin" 
+    pass   = "admin"
     host   = "http://127.0.0.1:9000"
 }
 ```
 
 ## Example: Authenticate with token
+
 ```terraform
 terraform {
   required_providers {
@@ -36,15 +44,16 @@ provider "sonarqube" {
 ```
 
 ## Argument Reference
+
 The following arguments are supported:
 
 - `user` - (Optional) Sonarqube user. This can also be set via the `SONARQUBE_USER` environment variable.
 - `pass` - (Optional) Sonarqube pass. This can also be set via the `SONARQUBE_PASS` environment variable.
 - `token` - (Optional) Sonarqube token. This can also be set via the `SONARQUBE_TOKEN` environment variable.
 - `host` - (Required) Sonarqube url. This can be also be set via the `SONARQUBE_HOST` environment variable.
-- `installed_version` - (Optional) The version of the Sonarqube server. When specified, the provider will avoid requesting this from the 
+- `installed_version` - (Optional) The version of the Sonarqube server. When specified, the provider will avoid requesting this from the
   server during the initialization process. This can be helpful when using the same Terraform code to install Sonarqube and configure it.
-- `tls_insecure_skip_verify` - (Optional) Allows ignoring insecure certificates when set to true. Defaults to false. Disabling TLS verification 
+- `tls_insecure_skip_verify` - (Optional) Allows ignoring insecure certificates when set to true. Defaults to false. Disabling TLS verification
   is dangerous and should only be done for local testing.
-- `anonymize_user_on_delete` - (Optional) Allows anonymizing users on destroy. Requires Sonarqube version >= `9.7`. This can be helpful 
+- `anonymize_user_on_delete` - (Optional) Allows anonymizing users on destroy. Requires Sonarqube version >= `9.7`. This can be helpful
   to comply with regulations like [GDPR](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation).
diff --git a/docs/resources/sonarqube_alm_azure.md b/docs/resources/sonarqube_alm_azure.md
@@ -1,4 +1,12 @@
-# sonarqube_alm_azure
+---
+page_title: "sonarqube_alm_azure Resource - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Provides a Sonarqube Azure Devops Alm/Devops Platform Integration resource. This can be used to create and manage a Alm/Devops
+  Platform Integration for Azure Devops.
+---
+
+# sonarqube_alm_azure (Resource)
 
 Provides a Sonarqube Azure Devops Alm/Devops Platform Integration resource. This can be used to create and manage a Alm/Devops
 Platform Integration for Azure Devops.

diff --git a/docs/resources/sonarqube_alm_github.md b/docs/resources/sonarqube_alm_github.md
@@ -1,4 +1,12 @@
-# sonarqube_alm_github
+---
+page_title: "sonarqube_alm_github Resource - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Provides a Sonarqube GitHub Alm/Devops Platform Integration resource. This can be used to create and manage a Alm/Devops
+  Platform Integration for GitHub.
+---
+
+# sonarqube_alm_github (Resource)
 
 Provides a Sonarqube GitHub Alm/Devops Platform Integration resource. This can be used to create and manage a Alm/Devops
 Platform Integration for GitHub.
@@ -37,4 +45,3 @@ The following attributes are exported:
 - client_id - GitHub App Client ID.
 - key - The unique key of the GitHub instance setting.
 - url - GitHub API URL.
-
diff --git a/docs/resources/sonarqube_alm_gitlab.md b/docs/resources/sonarqube_alm_gitlab.md
@@ -1,4 +1,12 @@
-# sonarqube_alm_gitlab
+---
+page_title: "sonarqube_alm_gitlab Resource - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Provides a Sonarqube GitLab Alm/Devops Platform Integration resource. This can be used to create and manage a Alm/Devops
+  Platform Integration for GitLab.
+---
+
+# sonarqube_alm_gitlab (Resource)
 
 Provides a Sonarqube GitLab Alm/Devops Platform Integration resource. This can be used to create and manage a Alm/Devops
 Platform Integration for GitLab.
@@ -27,4 +35,3 @@ The following attributes are exported:
 
 - key - The unique key of the GitLab instance setting.
 - url - GitLab API URL.
-
diff --git a/docs/resources/sonarqube_azure_binding.md b/docs/resources/sonarqube_azure_binding.md
@@ -1,4 +1,12 @@
-# sonarqube_azure_binding
+---
+page_title: "sonarqube_azure_binding Resource - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Provides a Sonarqube Azure Devops binding resource. This can be used to create and manage the binding between an
+  Azure Devops repository and a SonarQube project
+---
+
+# sonarqube_azure_binding (Resource)
 
 Provides a Sonarqube Azure Devops binding resource. This can be used to create and manage the binding between an
 Azure Devops repository and a SonarQube project

diff --git a/docs/resources/sonarqube_github_binding.md b/docs/resources/sonarqube_github_binding.md
@@ -1,4 +1,12 @@
-# sonarqube_github_binding
+---
+page_title: "sonarqube_github_binding Resource - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Provides a Sonarqube GitHub binding resource. This can be used to create and manage the binding between a
+  GitHub repository and a SonarQube project
+---
+
+# sonarqube_github_binding (Resource)
 
 Provides a Sonarqube GitHub binding resource. This can be used to create and manage the binding between a
 GitHub repository and a SonarQube project
@@ -52,4 +60,4 @@ Bindings can be imported using their ID
 
 ```terraform
 terraform import sonarqube_github_binding.github-binding project/repository
-```
+```
diff --git a/docs/resources/sonarqube_gitlab_binding.md b/docs/resources/sonarqube_gitlab_binding.md
@@ -1,4 +1,12 @@
-# sonarqube_gitlab_binding
+---
+page_title: "sonarqube_gitlab_binding Resource - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Provides a Sonarqube GitLab binding resource. This can be used to create and manage the binding between a
+  GitLab repository and a SonarQube project
+---
+
+# sonarqube_gitlab_binding (Resource)
 
 Provides a Sonarqube GitLab binding resource. This can be used to create and manage the binding between a
 GitLab repository and a SonarQube project

diff --git a/docs/resources/sonarqube_group.md b/docs/resources/sonarqube_group.md
@@ -1,4 +1,11 @@
-# sonarqube_group
+---
+page_title: "sonarqube_group Resource - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Provides a Sonarqube Group resource. This can be used to create and manage Sonarqube Groups.
+---
+
+# sonarqube_group (Resource)
 
 Provides a Sonarqube Group resource. This can be used to create and manage Sonarqube Groups.
 

diff --git a/docs/resources/sonarqube_group_member.md b/docs/resources/sonarqube_group_member.md
@@ -1,4 +1,11 @@
-# sonarqube_group_member
+---
+page_title: "sonarqube_group_member Resource - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Provides a Sonarqube Group Member resource. This can be used to add or remove user to or from Sonarqube Groups.
+---
+
+# sonarqube_group_member (Resource)
 
 Provides a Sonarqube Group Member resource. This can be used to add or remove user to or from Sonarqube Groups.
 

diff --git a/docs/resources/sonarqube_new_code_periods.md b/docs/resources/sonarqube_new_code_periods.md
@@ -1,4 +1,11 @@
-# sonarqube_new_code_periods
+---
+page_title: "sonarqube_new_code_periods Resource - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Provides a Sonarqube New Code Periods resource. This can be used to manage Sonarqube New Code Periods.
+---
+
+# sonarqube_new_code_periods (Resource)
 
 Provides a Sonarqube New Code Periods resource. This can be used to manage Sonarqube New Code Periods.
 

diff --git a/docs/resources/sonarqube_permission_template.md b/docs/resources/sonarqube_permission_template.md
@@ -1,4 +1,12 @@
-# sonarqube_permission_template
+---
+page_title: "sonarqube_permission_template Resource - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Provides a Sonarqube Permission template resource. This can be used to create and manage Sonarqube Permission
+  templates.
+---
+
+# sonarqube_permission_template (Resource)
 
 Provides a Sonarqube Permission template resource. This can be used to create and manage Sonarqube Permission
 templates.

diff --git a/docs/resources/sonarqube_permissions.md b/docs/resources/sonarqube_permissions.md
@@ -1,4 +1,11 @@
-# sonarqube_permissions
+---
+page_title: "sonarqube_permissions Resource - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Provides a Sonarqube Permissions resource. This can be used to manage global and project permissions.
+---
+
+# sonarqube_permissions (Resource)
 
 Provides a Sonarqube Permissions resource. This can be used to manage global and project permissions.