Skip to content

Commit 07c6f9a

Browse files
authored
docs: fix and standardize doc pages (#544)
Adjust spelling of IP pool to match the rest of the documentation page.
1 parent 47b73cd commit 07c6f9a

30 files changed

+246
-123
lines changed

docs/data-sources/floating_ip.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ data "oxide_floating_ip" "example" {
3636
- `description` (String) Human-readable free-form text about the floating IP.
3737
- `id` (String) Unique, immutable, system-controlled identifier for the floating IP.
3838
- `instance_id` (String) Instance ID that this floating IP is attached to, if presently attached.
39-
- `ip` (String) IP address for this floating IP. If unset an IP address will be chosen from the given ip_pool_id.
39+
- `ip` (String) IP address for this floating IP. If unset an IP address will be chosen from the given `ip_pool_id`.
4040
- `ip_pool_id` (String) IP pool ID to allocate this floating IP from. If unset the silo's default IP pool is used.
4141
- `project_id` (String) Project ID where this floating IP is located.
4242
- `time_created` (String) Timestamp when this floating IP was created.

docs/data-sources/image.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ data "oxide_image" "example" {
3131

3232
### Optional
3333

34-
- `project_name` (String) Name of the project which contains the images
34+
- `project_name` (String) Name of the project which contains the image.
3535
- `timeouts` (Attributes) (see [below for nested schema](#nestedatt--timeouts))
3636

3737
### Read-Only
@@ -41,7 +41,7 @@ data "oxide_image" "example" {
4141
- `digest` (Attributes) Hash of the image contents, if applicable. (see [below for nested schema](#nestedatt--digest))
4242
- `id` (String) Unique, immutable, system-controlled identifier of the image.
4343
- `os` (String) OS image distribution.
44-
- `project_id` (String) ID of the project which contains the images
44+
- `project_id` (String) ID of the project which contains the image.
4545
- `size` (Number) Size of the image in bytes.
4646
- `time_created` (String) Timestamp of when this image was created.
4747
- `time_modified` (String) Timestamp of when this image was last modified.

docs/data-sources/images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ data "oxide_images" "example" {}
2121

2222
### Optional
2323

24-
- `project_id` (String) ID of the project which contains the images
24+
- `project_id` (String) ID of the project which contains the images.
2525
- `timeouts` (Attributes) (see [below for nested schema](#nestedatt--timeouts))
2626

2727
### Read-Only

docs/data-sources/silo.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "oxide_silo Data Source - terraform-provider-oxide"
44
subcategory: ""
55
description: |-
6-
Retrieve information about a specified Silo.
6+
Retrieve information about a specified silo.
77
---
88

99
# oxide_silo (Data Source)
1010

11-
Retrieve information about a specified Silo.
11+
Retrieve information about a specified silo.
1212

1313
## Example Usage
1414

@@ -26,20 +26,20 @@ data "oxide_silo" "example" {
2626

2727
### Required
2828

29-
- `name` (String) Name of the Silo.
29+
- `name` (String) Name of the silo.
3030

3131
### Optional
3232

3333
- `timeouts` (Attributes) (see [below for nested schema](#nestedatt--timeouts))
3434

3535
### Read-Only
3636

37-
- `description` (String) Description for the Silo.
38-
- `discoverable` (Boolean) A silo where discoverable is false can be retrieved only by its ID - it will not be part of the 'list all silos' output
39-
- `id` (String) Unique, immutable, system-controlled identifier of the Silo.
40-
- `identity_mode` (String) How users and groups are managed in this Silo.
41-
- `time_created` (String) Timestamp of when this Silo was created.
42-
- `time_modified` (String) Timestamp of when this Silo was last modified.
37+
- `description` (String) Description for the silo.
38+
- `discoverable` (Boolean) A silo where discoverable is false can be retrieved only by its ID - it will not be part of the 'list all silos' output.
39+
- `id` (String) Unique, immutable, system-controlled identifier of the silo.
40+
- `identity_mode` (String) How users and groups are managed in this silo.
41+
- `time_created` (String) Timestamp of when this silo was created.
42+
- `time_modified` (String) Timestamp of when this silo was last modified.
4343

4444
<a id="nestedatt--timeouts"></a>
4545
### Nested Schema for `timeouts`

docs/data-sources/system_ip_pools.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,22 @@
33
page_title: "oxide_system_ip_pools Data Source - terraform-provider-oxide"
44
subcategory: ""
55
description: |-
6-
6+
Retrieve all configured IP pools for the Oxide system.
77
---
88

99
# oxide_system_ip_pools (Data Source)
1010

11+
Retrieve all configured IP pools for the Oxide system.
1112

13+
## Example Usage
1214

13-
15+
```terraform
16+
data "oxide_system_ip_pools" "example" {
17+
timeouts = {
18+
read = "1m"
19+
}
20+
}
21+
```
1422

1523
<!-- schema generated by tfplugindocs -->
1624
## Schema

docs/data-sources/vpc_router_route.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -62,18 +62,23 @@ Optional:
6262

6363
Read-Only:
6464

65-
- `type` (String) Route destination type. Possible values: `vpc`, `subnet`, `ip`, `ip_net`
65+
- `type` (String) Route destination type. Possible values: `vpc`, `subnet`, `ip`, `ip_net`.
6666
- `value` (String) Depending on the type, it will be one of the following:
67-
- `vpc`: Name of the VPC
68-
- `subnet`: Name of the VPC subnet
69-
- `ip`: IP address
70-
- `ip_net`: IPv4 or IPv6 subnet
67+
- `vpc`: Name of the VPC.
68+
- `subnet`: Name of the VPC subnet.
69+
- `ip`: IP address.
70+
- `ip_net`: IPv4 or IPv6 subnet.
7171

7272

7373
<a id="nestedatt--target"></a>
7474
### Nested Schema for `target`
7575

7676
Read-Only:
7777

78-
- `type` (String) Route destination type. Possible values: vpc, subnet, instance, ip, internet_gateway, drop
79-
- `value` (String) Depending on the type, it will be one of the following:- `vpc`: Name of the VPC - `subnet`: Name of the VPC subnet - `instance`: Name of the instance- `ip`: IP address - `internet_gateway`: name of the internet gateway
78+
- `type` (String) Route destination type. Possible values: `vpc`, `subnet`, `instance`, `ip`, `internet_gateway`, `drop`.
79+
- `value` (String) Depending on the type, it will be one of the following:
80+
- `vpc`: Name of the VPC.
81+
- `subnet`: Name of the VPC subnet.
82+
- `instance`: Name of the instance.
83+
- `ip`: IP address.
84+
- `internet_gateway`: Name of the internet gateway.

docs/resources/anti_affinity_group.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ resource "oxide_anti_affinity_group" "example" {
3434

3535
- `description` (String) Description for the anti-affinity group.
3636
- `name` (String) Name of the anti-affinity group.
37-
- `policy` (String) Affinity policy used to describe what to do when a request cannot be satisfied
37+
- `policy` (String) Affinity policy used to describe what to do when a request cannot be satisfied.
3838
- `project_id` (String) ID of the project that will contain the anti-affinity group.
3939

4040
### Optional

docs/resources/image.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ resource "oxide_image" "example2" {
3434

3535
- `description` (String) Description for the image.
3636
- `name` (String) Name of the image.
37-
- `os` (String) OS image distribution. Example: alpine
37+
- `os` (String) OS image distribution. Example: `"alpine"`.
3838
- `project_id` (String) ID of the project that will contain the image.
3939
- `source_snapshot_id` (String) Snapshot ID of the image source if applicable.
40-
- `version` (String) OS image version. Example: 3.16.
40+
- `version` (String) OS image version. Example: `"3.16"`.
4141

4242
### Optional
4343

docs/resources/instance.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ resource "oxide_instance" "example" {
106106
### Required
107107

108108
- `description` (String) Description for the instance.
109-
- `host_name` (String) Host name of the instance
109+
- `host_name` (String) Host name of the instance.
110110
- `memory` (Number) Instance memory in bytes.
111111
- `name` (String) Name of the instance.
112112
- `ncpus` (Number) Number of CPUs allocated for this instance.
@@ -115,7 +115,7 @@ resource "oxide_instance" "example" {
115115
### Optional
116116

117117
- `anti_affinity_groups` (Set of String) IDs of the anti-affinity groups this instance should belong to.
118-
- `auto_restart_policy` (String)
118+
- `auto_restart_policy` (String) The auto-restart policy for this instance.
119119
- `boot_disk_id` (String) ID of the disk the instance should be booted from. When provided, this ID must also be present in `disk_attachments`.
120120
- `disk_attachments` (Set of String) IDs of the disks to be attached to the instance. When multiple disk IDs are provided, set `book_disk_id` to specify the boot disk for the instance. Otherwise, a boot disk will be chosen randomly.
121121
- `external_ips` (Attributes Set) External IP addresses provided to this instance. (see [below for nested schema](#nestedatt--external_ips))
@@ -142,7 +142,7 @@ Required:
142142

143143
Optional:
144144

145-
- `id` (String) If `type` is `ephemeral`, ID of the IP pool to retrieve addresses from, or all available pools if not specified. If `type` is `floating`, ID of the floating IP
145+
- `id` (String) If `type` is `ephemeral`, ID of the IP pool to retrieve addresses from, or all available pools if not specified. If `type` is `floating`, ID of the floating IP.
146146

147147

148148
<a id="nestedatt--network_interfaces"></a>
@@ -153,7 +153,7 @@ Required:
153153
- `description` (String) Description for the instance network interface.
154154
- `name` (String) Name of the instance network interface.
155155
- `subnet_id` (String) ID of the VPC subnet in which to create the instance network interface.
156-
- `vpc_id` (String) ID of the VPC in which to create the instance network interface
156+
- `vpc_id` (String) ID of the VPC in which to create the instance network interface.
157157

158158
Optional:
159159

docs/resources/ip_pool.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ resource "oxide_ip_pool" "example" {
5555

5656
Required:
5757

58-
- `first_address` (String) First address in the range
59-
- `last_address` (String) Last address in the range
58+
- `first_address` (String) First address in the range.
59+
- `last_address` (String) Last address in the range.
6060

6161

6262
<a id="nestedatt--timeouts"></a>

0 commit comments

Comments
 (0)