Skip to content

Commit bd8963d

Browse files
authored
📄 Edit resource docs and messages (#190)
* Edit resource docs and messages * generated markdown
1 parent 4778115 commit bd8963d

57 files changed

Lines changed: 280 additions & 280 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/resources/custom_framework.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "mondoo_custom_framework Resource - terraform-provider-mondoo"
44
subcategory: ""
55
description: |-
6-
Set custom Compliance Frameworks for a Mondoo Space.
6+
Set custom compliance frameworks for a Mondoo space.
77
---
88

99
# mondoo_custom_framework (Resource)
1010

11-
Set custom Compliance Frameworks for a Mondoo Space.
11+
Set custom compliance frameworks for a Mondoo space.
1212

1313
## Example Usage
1414

@@ -33,12 +33,12 @@ resource "mondoo_custom_framework" "custom_framework" {
3333

3434
### Required
3535

36-
- `data_url` (String) URL to the custom Compliance Framework data.
36+
- `data_url` (String) URL to the custom compliance framework data.
3737

3838
### Optional
3939

40-
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
40+
- `space_id` (String) Mondoo space identifier. If there's no space ID, the provider space is used.
4141

4242
### Read-Only
4343

44-
- `mrn` (String) Mondoo Resource Name.
44+
- `mrn` (String) Mondoo resource name.

‎docs/resources/custom_policy.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ resource "mondoo_policy_assignment" "space" {
4646
- `content` (String, Sensitive) Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive. To view the raw contents of the object, please define an output.
4747
- `overwrite` (Boolean) If set to true, existing policies are overwritten.
4848
- `source` (String) A path to the data you want to upload. Must be defined if content is not.
49-
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
49+
- `space_id` (String) Mondoo space identifier. If there is no space ID, the provider space is used.
5050

5151
### Read-Only
5252

‎docs/resources/custom_querypack.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ resource "mondoo_querypack_assignment" "space" {
4545
- `content` (String, Sensitive) Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive. To view the raw contents of the object, please define an output.
4646
- `overwrite` (Boolean) If set to true, existing policies are overwritten.
4747
- `source` (String) A path to the data you want to upload. Must be defined if content is not.
48-
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
48+
- `space_id` (String) Mondoo space identifier. If there is no space ID, the provider space is used.
4949

5050
### Read-Only
5151

‎docs/resources/exception.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "mondoo_exception Resource - terraform-provider-mondoo"
44
subcategory: ""
55
description: |-
6-
Set custom exceptions for a Scope.
6+
Set custom exceptions for a scope.
77
---
88

99
# mondoo_exception (Resource)
1010

11-
Set custom exceptions for a Scope.
11+
Set custom exceptions for a scope.
1212

1313
## Example Usage
1414

@@ -47,9 +47,9 @@ resource "mondoo_exception" "exception" {
4747

4848
### Optional
4949

50-
- `action` (String) The action to perform. Default is `SNOOZE`. Other options are `ENABLE`, `DISABLE`, `OUT_OF_SCOPE`.
50+
- `action` (String) The action to perform. Default is `SNOOZE`. Other options are `ENABLE`, `DISABLE`, and `OUT_OF_SCOPE`.
5151
- `check_mrns` (List of String) List of check MRNs to set exceptions for. If set, `vulnerability_mrns` must not be set.
5252
- `justification` (String) Description why the exception is required.
5353
- `scope_mrn` (String) The MRN of the scope (either asset mrn or space mrn).
54-
- `valid_until` (String) The timestamp until the exception is valid.
54+
- `valid_until` (String) The date when the exception is no longer valid.
5555
- `vulnerability_mrns` (List of String) List of vulnerability MRNs to set exceptions for. If set, `check_mrns` must not be set.

‎docs/resources/framework_assignment.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "mondoo_framework_assignment Resource - terraform-provider-mondoo"
44
subcategory: ""
55
description: |-
6-
Set Compliance Frameworks for a Mondoo Space.
6+
Set compliance frameworks for a Mondoo space.
77
---
88

99
# mondoo_framework_assignment (Resource)
1010

11-
Set Compliance Frameworks for a Mondoo Space.
11+
Set compliance frameworks for a Mondoo space.
1212

1313
## Example Usage
1414

@@ -31,9 +31,9 @@ resource "mondoo_framework_assignment" "framework_assignment" {
3131

3232
### Required
3333

34-
- `enabled` (Boolean) Enable or disable the Compliance Framework.
35-
- `framework_mrn` (List of String) Compliance Framework MRN.
34+
- `enabled` (Boolean) Enable or disable the compliance framework.
35+
- `framework_mrn` (List of String) Compliance framework MRN.
3636

3737
### Optional
3838

39-
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
39+
- `space_id` (String) Mondoo space identifier. If there's no ID, the provider space is used.

‎docs/resources/integration_aws.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ resource "mondoo_integration_aws" "name" {
5252

5353
### Optional
5454

55-
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
55+
- `space_id` (String) Mondoo space identifier. If there is no ID, the provider space is used.
5656

5757
### Read-Only
5858

‎docs/resources/integration_aws_serverless.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,10 +101,10 @@ resource "aws_cloudformation_stack" "mondoo_stack" {
101101
### Optional
102102

103103
- `account_ids` (List of String) List of AWS account IDs.
104-
- `console_sign_in_trigger` (Boolean) Enable console sign in trigger.
104+
- `console_sign_in_trigger` (Boolean) Enable console sign-in trigger.
105105
- `instance_state_change_trigger` (Boolean) Enable instance state change trigger.
106106
- `is_organization` (Boolean) Is organization.
107-
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
107+
- `space_id` (String) Mondoo space identifier. If there is no ID, the provider space is used.
108108

109109
### Read-Only
110110

@@ -136,7 +136,7 @@ Optional:
136136
- `ebs_volume_scan` (Boolean) Enable EBS volume scan.
137137
- `exclude_instance_ids_filter` (List of String) List of instance IDs to exclude.
138138
- `exclude_regions_filter` (List of String) List of regions to exclude.
139-
- `exclude_tags_filter` (Map of String) Excluded Tags filter.
139+
- `exclude_tags_filter` (Map of String) Excluded tags filter.
140140
- `instance_connect` (Boolean) Enable instance connect.
141141
- `instance_ids_filter` (List of String) List of instance IDs filter.
142142
- `regions_filter` (List of String) List of regions filter.

‎docs/resources/integration_azure.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "mondoo_integration_azure Resource - terraform-provider-mondoo"
44
subcategory: ""
55
description: |-
6-
Continuously scan Microsoft Azure subscriptions and resources for misconfigurations and vulnerabilities. See Mondoo documentation https://mondoo.com/docs/platform/infra/cloud/azure/azure-integration-scan-subscription/ for more details.
6+
Continuously scan Microsoft Azure subscriptions and resources for misconfigurations and vulnerabilities. To learn more, read the Mondoo documentation https://mondoo.com/docs/platform/infra/cloud/azure/azure-integration-scan-subscription/.
77
---
88

99
# mondoo_integration_azure (Resource)
1010

11-
Continuously scan Microsoft Azure subscriptions and resources for misconfigurations and vulnerabilities. See [Mondoo documentation](https://mondoo.com/docs/platform/infra/cloud/azure/azure-integration-scan-subscription/) for more details.
11+
Continuously scan Microsoft Azure subscriptions and resources for misconfigurations and vulnerabilities. To learn more, read the [Mondoo documentation](https://mondoo.com/docs/platform/infra/cloud/azure/azure-integration-scan-subscription/).
1212

1313
## Example Usage
1414

@@ -278,15 +278,15 @@ resource "mondoo_integration_azure" "azure_integration" {
278278

279279
### Required
280280

281-
- `client_id` (String) Azure Client ID.
281+
- `client_id` (String) Azure client ID.
282282
- `credentials` (Attributes) (see [below for nested schema](#nestedatt--credentials))
283283
- `name` (String) Name of the integration.
284-
- `tenant_id` (String) Azure Tenant ID.
284+
- `tenant_id` (String) Azure tenant ID.
285285

286286
### Optional
287287

288288
- `scan_vms` (Boolean) Scan VMs.
289-
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
289+
- `space_id` (String) Mondoo space identifier. If there is no space ID, the provider space is used.
290290
- `subscription_allow_list` (List of String) List of Azure subscriptions to scan.
291291
- `subscription_deny_list` (List of String) List of Azure subscriptions to exclude from scanning.
292292

‎docs/resources/integration_domain.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ resource "mondoo_integration_domain" "domain_integration" {
3636

3737
- `http` (Boolean) Enable HTTP port.
3838
- `https` (Boolean) Enable HTTPS port.
39-
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
39+
- `space_id` (String) Mondoo space identifier. If there is no space ID, the provider space is used.
4040

4141
### Read-Only
4242

‎docs/resources/integration_email.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "mondoo_integration_email Resource - terraform-provider-mondoo"
44
subcategory: ""
55
description: |-
6-
Send an email to your ticket system, or any recipient.
6+
Send email to your ticket system or any recipient.
77
---
88

99
# mondoo_integration_email (Resource)
1010

11-
Send an email to your ticket system, or any recipient.
11+
Send email to your ticket system or any recipient.
1212

1313
## Example Usage
1414

@@ -53,7 +53,7 @@ resource "mondoo_integration_email" "email_integration" {
5353

5454
- `auto_close` (Boolean) Auto close tickets (defaults to false).
5555
- `auto_create` (Boolean) Auto create tickets (defaults to false).
56-
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
56+
- `space_id` (String) Mondoo space identifier. If there is no space ID, the provider space is used.
5757

5858
### Read-Only
5959

@@ -69,5 +69,5 @@ Required:
6969

7070
Optional:
7171

72-
- `is_default` (Boolean) Mark this recipient as default. This needs to be set if auto_create is enabled.
73-
- `reference_url` (String) Reference URL for the recipient.
72+
- `is_default` (Boolean) Mark this recipient as default. This must be set if auto_create is enabled.
73+
- `reference_url` (String) Optional reference URL for the recipient.

0 commit comments

Comments
 (0)