Skip to content

Commit cf42660

Browse files
tenthirtyamtenthirtyam
committed
docs: markdown formatting
- Addresses common markdown formatting issues in `./website` content. - Updates "vRealize Automation" to "Aria Automation" to match the project description. This should later be changed to `VMware Cloud Foundation Automation" and denote use for the classic experience. Signed-off-by: Ryan Johnson <[email protected]>
1 parent 111df8d commit cf42660

File tree

76 files changed

+844
-814
lines changed

Some content is hidden

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

76 files changed

+844
-814
lines changed

‎website/docs/d/vra_block_device.html.markdown

+7-11
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
---layout: "vra"
2-
page_title: "VMware vRealize Automation: vra_block_device"
1+
---
2+
layout: "vra"
3+
page_title: "VMware Aria Automation: vra_block_device"
34
description: |-
45
Provides a data lookup for vra_block_device.
56
---
@@ -18,7 +19,6 @@ This is an example of how to read a block device data source using its ID.
1819
data "vra_block_device" "this" {
1920
id = var.block_device_id
2021
}
21-
2222
```
2323

2424
**Block device data source filter by name:**
@@ -29,7 +29,6 @@ This is an example of how to read a block device data source using its name.
2929
data "vra_block_device" "this" {
3030
filter = "name eq '${var.block_device_name}'"
3131
}
32-
3332
```
3433

3534
## Argument Reference
@@ -74,17 +73,14 @@ A block device data source supports the following attributes:
7473

7574
* `persistent` - Indicates whether the block device survives a delete action.
7675

77-
* `links` - HATEOAS of the entity.
76+
* `links` - Hypermedia as the Engine of Application State (HATEOAS) of the entity.
7877

7978
* `status` - Status of the block device.
8079

81-
* `tags` - A set of tag keys and optional values that were set on this resource instance.
82-
example: `[ { "key" : "vmware.enumeration.type", "value": "nebs_block" } ]`
80+
* `tags` - A set of tag keys and optional values that were set on this resource instance. Example: `[ { "key" : "vmware.enumeration.type", "value": "nebs_block" } ]`
81+
8382
* `key` - Tag’s key.
83+
8484
* `value` - Tag’s value.
8585

8686
* `updated_at` - Date when the entity was last updated. The date is ISO 8601 and UTC.
87-
88-
89-
90-

‎website/docs/d/vra_block_device_snapshot.html.markdown

+8-5
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
1-
---layout: "vra"
2-
page_title: "VMware vRealize Automation: vra_block_device_snapshots"
1+
---
2+
layout: "vra"
3+
page_title: "VMware Aria Automation: vra_block_device_snapshots"
34
description: |-
45
Provides a data lookup for vra_block_device_snapshots.
56
---
67

78
# Data Source: vra_block_device_snapshots
9+
810
## Example Usages
911

1012
This is an example of how to read a block device snapshots data source.
1113

1214
**Block device snapshots data source by its id:**
15+
1316
```hcl
1417
1518
data "vra_block_device_snapshot" "snapshot" {
1619
block_device_id = var.block_device_id
1720
}
18-
1921
```
22+
2023
## Argument Reference
2124

2225
* `var.block_device_id` - (Required) The id of the existing block device.
@@ -29,9 +32,9 @@ data "vra_block_device_snapshot" "snapshot" {
2932

3033
* `is_current` - Indicates whether this snapshot is the current snapshot on the block-device.
3134

32-
* `links` - HATEOAS of the entity
35+
* `links` - Hypermedia as the Engine of Application State (HATEOAS) of the entity.
3336

34-
* `name` - A human-friendly name used as an identifier in APIs that support this option. Only one of 'filter', 'id', 'name' or 'region_id' must be specified.
37+
* `name` - A human-friendly name used as an identifier in APIs that support this option. Only one of `filter`, `id`, `name`, or `region_id` must be specified.
3538

3639
* `org_id` - The id of the organization this entity belongs to.
3740

‎website/docs/d/vra_blueprint.html.markdown

+20-20
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
---
22
layout: "vra"
3-
page_title: "VMware vRealize Automation: Data source vra_blueprint"
4-
description: A blueprint data source.
3+
page_title: "VMware Aria Automation: Data source vra_blueprint"
4+
description: A cloud template (blueprint) data source.
55
---
66

7-
# Data Source: vra\_blueprint
7+
# Data Source: vra_blueprint
88

9-
This data source provides information about a cloud template (blueprint) in vRA.
9+
This data source provides information about a cloud template (blueprint).
1010

1111
## Example Usages
1212

13-
This is an example of how to get a vRA cloud template by its name.
13+
This is an example of how to get a cloud template by its name.
1414

1515
```hcl
1616
data "vra_blueprint" "this" {
1717
name = vra_blueprint.this.name
1818
}
1919
```
2020

21-
This is an example of how to get a vRA cloud template by its id.
21+
This is an example of how to get a cloud template by its id.
2222

2323
```hcl
2424
data "vra_blueprint" "this" {
@@ -32,14 +32,13 @@ data "vra_blueprint" "this" {
3232

3333
* `name` - (Optional) Name of the cloud template. One of `id` or `name` must be provided.
3434

35-
* `project_id` - (Optional) The id of the project to narrow the search while looking for cloud templates.
36-
35+
* `project_id` - (Optional) The id of the project to narrow the search while looking for cloud templates.
3736

3837
## Attribute Reference
3938

4039
* `content` - Blueprint YAML content.
4140

42-
* `content_source_id` - The id of the content source.
41+
* `content_source_id` - The id of the content source.
4342

4443
* `content_source_path` - Content source path.
4544

@@ -61,13 +60,13 @@ data "vra_blueprint" "this" {
6160

6261
* `project_name` - The name of the project the entity belongs to.
6362

64-
* `self_link` - HATEOAS of the entity.
63+
* `self_link` - Hypermedia as the Engine of Application State (HATEOAS) of the entity.
6564

6665
* `request_scope_org` - Flag to indicate whether this blueprint can be requested from any project in the organization this entity belongs to.
6766

6867
* `status` - Status of the cloud template. Supported values: `DRAFT`, `VERSIONED`, `RELEASED`.
6968

70-
* `total_released_versions` - Total number of released versions.
69+
* `total_released_versions` - Total number of released versions.
7170

7271
* `total_versions` - Total number of versions.
7372

@@ -78,12 +77,13 @@ data "vra_blueprint" "this" {
7877
* `valid` - Flag to indicate if the current content of the cloud template is valid.
7978

8079
* `validation_messages` - List of validations messages.
81-
* message - Validation message.
82-
83-
* metadata - Validation metadata.
84-
85-
* path - Validation path.
86-
87-
* resource_name - Name of the resource.
88-
89-
* type - Message type. Supported values: `INFO`, `WARNING`, `ERROR`.
80+
81+
* `message` - Validation message.
82+
83+
* `metadata` - Validation metadata.
84+
85+
* `path` - Validation path.
86+
87+
* `resource_name` - Name of the resource.
88+
89+
* `type` - Message type. Supported values: `INFO`, `WARNING`, `ERROR`.

‎website/docs/d/vra_blueprint_version.html.markdown

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
layout: "vra"
3-
page_title: "VMware vRealize Automation: Data source vra_blueprint_version"
3+
page_title: "VMware Aria Automation: Data source vra_blueprint_version"
44
description: A blueprint version data source.
55
---
66

7-
# Data Source: vra\_blueprint\_version
7+
# Data Source: vra_blueprint_version
88

9-
This data source provides information about a cloud template (blueprint) version in vRA.
9+
This data source provides information about a cloud template (blueprint) version.
1010

1111
## Example Usages
1212

@@ -23,7 +23,6 @@ data "vra_blueprint_version" "this" {
2323

2424
* `id` - (Required) The id of the cloud template version.
2525

26-
2726
## Attribute Reference
2827

2928
* `blueprint_description` - Description of the cloud template.

‎website/docs/d/vra_catalog_item.html.markdown

+26-27
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
layout: "vra"
3-
page_title: "VMware vRealize Automation: Data source vra_catalog_item"
3+
page_title: "VMware Aria Automation: Data source vra_catalog_item"
44
description: A data source for a catalog item.
55
---
66

7-
# Data Source: vra\_catalog\_item
7+
# Data Source: vra_catalog_item
88

9-
This data source provides information about a catalog item in vRA.
9+
This data source provides information about a catalog item.
1010

1111
## Example Usages
1212

13-
This is an example of how to get a vRA catalog item by its name.
13+
This is an example of how to get a catalog item by its name.
1414

1515
```hcl
1616
data "vra_catalog_item" "this" {
@@ -19,7 +19,7 @@ data "vra_catalog_item" "this" {
1919
}
2020
```
2121

22-
This is an example of how to get a vRA catalog item by its id.
22+
This is an example of how to get a catalog item by its id.
2323

2424
```hcl
2525
data "vra_catalog_item" "this" {
@@ -28,7 +28,6 @@ data "vra_catalog_item" "this" {
2828
}
2929
```
3030

31-
3231
## Argument Reference
3332

3433
* `expand_projects` - (Optional) Flag to indicate whether to expand detailed project data for the catalog item.
@@ -61,34 +60,34 @@ data "vra_catalog_item" "this" {
6160

6261
* `projects` - List of associated projects that can be used for requesting this catalog item.
6362

64-
* `description` - A human friendly description.
65-
66-
* `id` - Id of the entity.
67-
68-
* `name` - Name of the entity.
69-
70-
* `version` - Version of the entity, if applicable.
63+
* `description` - A human friendly description.
64+
65+
* `id` - Id of the entity.
66+
67+
* `name` - Name of the entity.
7168

72-
* `schema` - Json schema describing request parameters, a simplified version of http://json-schema.org/latest/json-schema-validation.html#rfc.section.5
69+
* `version` - Version of the entity, if applicable.
70+
71+
* `schema` - JSON schema describing request parameters, a simplified version of <http://json-schema.org/latest/json-schema-validation.html#rfc.section.5>
7372

7473
* `source_id` - LibraryItem source ID.
7574

7675
* `source_name` - LibraryItem source name.
7776

78-
* `type` -
77+
* `type` -
78+
79+
* `description` - A human friendly description.
7980

80-
* `description` - A human friendly description.
81-
82-
* `id` - Id of the entity.
83-
84-
* `name` - Name of the entity.
85-
86-
* `version` - Version of the entity, if applicable.
81+
* `id` - Id of the entity.
82+
83+
* `name` - Name of the entity.
84+
85+
* `version` - Version of the entity, if applicable.
8786

8887
* `versions` - Catalog item versions.
8988

90-
* `created_at` - Date-time when catalog item version was created at.
91-
92-
* `description` - A human-friendly description.
93-
94-
* `id` - Id of the catalog item version.
89+
* `created_at` - Date-time when catalog item version was created at.
90+
91+
* `description` - A human-friendly description.
92+
93+
* `id` - Id of the catalog item version.

‎website/docs/d/vra_catalog_item_entitlement.html.markdown

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
22
layout: "vra"
3-
page_title: "VMware vRealize Automation: vra_catalog_item_entitlement"
3+
page_title: "VMware Aria Automation: vra_catalog_item_entitlement"
44
description: A data source for catalog item entitlement.
55
---
66

7-
# Data Source: vra\_catalog\_item\_entitlement
7+
# Data Source: vra_catalog_item_entitlement
88

99
> **Note**: Deprecated - please use `vra_content_sharing_policy` instead.
1010
11-
This data source provides information about a catalog item entitlement in vRA.
11+
This data source provides information about a catalog item entitlement.
1212

1313
## Example Usages
1414

15-
This is an example of how to get a vRA catalog item entitlement by its id:
15+
This is an example of how to get a catalog item entitlement by its id:
1616

1717
```hcl
1818
data "vra_catalog_item_entitlement" "this" {
@@ -21,7 +21,7 @@ data "vra_catalog_item_entitlement" "this" {
2121
}
2222
```
2323

24-
This is an example of how to get a vRA catalog item entitlement by its catalog item id:
24+
This is an example of how to get a catalog item entitlement by its catalog item id:
2525

2626
```hcl
2727
data "vra_catalog_item_entitlement" "this" {
@@ -42,18 +42,18 @@ data "vra_catalog_item_entitlement" "this" {
4242

4343
* `definition` - Represents a catalog item that is linked to a project via an entitlement.
4444

45-
* `description` - Description of the catalog item.
45+
* `description` - Description of the catalog item.
4646

47-
* `icon_id` - Icon id of associated catalog item.
47+
* `icon_id` - Icon id of associated catalog item.
4848

49-
* `id` - Id of the catalog item.
49+
* `id` - Id of the catalog item.
5050

51-
* `name` - Name of the catalog item.
51+
* `name` - Name of the catalog item.
5252

53-
* `number_of_items` - Number of items in the associated catalog source.
53+
* `number_of_items` - Number of items in the associated catalog source.
5454

55-
* `source_name` - Catalog source name.
55+
* `source_name` - Catalog source name.
5656

57-
* `source_type` - Catalog source type.
57+
* `source_type` - Catalog source type.
5858

59-
* `type` - Content definition type.
59+
* `type` - Content definition type.

0 commit comments

Comments
 (0)