Skip to content

Commit 572796d

Browse files
jamtur01stack72
authored andcommitted
Fixed some formatting issues and language with the Softlayer docs (hashicorp#10732)
1 parent 70b1f4e commit 572796d

3 files changed

Lines changed: 27 additions & 27 deletions

File tree

website/source/docs/providers/softlayer/index.html.markdown

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,19 @@ The SoftLayer provider is used to manage SoftLayer resources.
1212

1313
Use the navigation to the left to read about the available resources.
1414

15-
<div class="alert alert-block alert-info">
16-
<strong>Note:</strong> The SoftLayer provider is new as of Terraform 0.X.
15+
-> **Note:** The SoftLayer provider is new as of Terraform 0.6.16.
1716
It is ready to be used but many features are still being added. If there
1817
is a SoftLayer feature missing, please report it in the GitHub repo.
19-
</div>
2018

2119
## Example Usage
2220

2321
Here is an example that will setup the following:
22+
2423
+ An SSH key resource.
2524
+ A virtual server resource that uses an existing SSH key.
26-
+ A virtual server resource using an existing SSH key and a Terraform managed SSH key (created as "test_key_1" in the example below).
25+
+ A virtual server resource using an existing SSH key and a Terraform managed SSH key (created as `test_key_1` in the example below).
2726

28-
(create this as sl.tf and run terraform commands from this directory):
27+
Add the below to a file called `sl.tf` and run the `terraform` command from the same directory:
2928

3029
```hcl
3130
provider "softlayer" {

website/source/docs/providers/softlayer/r/ssh_key.html.markdown

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ resource "softlayer_ssh_key" "test_ssh_key" {
2525

2626
The following arguments are supported:
2727

28-
* `name` - (Required) A descriptive name used to identify a ssh key.
29-
* `public_key` - (Required) The public ssh key.
30-
* `notes` - (Optional) A small note about a ssh key to use at your discretion.
28+
* `name` - (Required) A descriptive name used to identify an SSH key.
29+
* `public_key` - (Required) The public SSH key.
30+
* `notes` - (Optional) A small note about an SSH key to use at your discretion.
3131

32-
Fields `name` and `notes` are editable.
32+
The `name` and `notes` fields are editable.
3333

3434
## Attributes Reference
3535

3636
The following attributes are exported:
3737

38-
* `id` - id of the new ssh key
39-
* `fingerprint` - sequence of bytes to authenticate or lookup a longer ssh key.
38+
* `id` - The ID of the new SSH key
39+
* `fingerprint` - sequence of bytes to authenticate or lookup a longer SSH key.

website/source/docs/providers/softlayer/r/virtual_guest.html.markdown

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ and deleted. For additional details please refer to [API documentation](http://s
1313

1414
## Example Usage
1515

16-
```
17-
# Create a new virtual guest using image "Debian"
16+
Create a new virtual guest using the "Debian" image.
17+
18+
```hcl
1819
resource "softlayer_virtual_guest" "twc_terraform_sample" {
1920
name = "twc-terraform-sample-name"
2021
domain = "bar.example.com"
@@ -34,8 +35,9 @@ resource "softlayer_virtual_guest" "twc_terraform_sample" {
3435
}
3536
```
3637

37-
```
38-
# Create a new virtual guest using block device template
38+
Create a new virtual guest using block device template.
39+
40+
```hcl
3941
resource "softlayer_virtual_guest" "terraform-sample-BDTGroup" {
4042
name = "terraform-sample-blockDeviceTemplateGroup"
4143
domain = "bar.example.com"
@@ -69,21 +71,21 @@ The following arguments are supported:
6971
* Specifies which datacenter the instance is to be provisioned in.
7072
* **Required**
7173
* `hourly_billing` | *boolean*
72-
* Specifies the billing type for the instance. When true the computing instance will be billed on hourly usage, otherwise it will be billed on a monthly basis.
74+
* Specifies the billing type for the instance. When `true`, the computing instance will be billed on hourly usage, otherwise it will be billed on a monthly basis.
7375
* **Required**
7476
* `local_disk` | *boolean*
75-
* Specifies the disk type for the instance. When true the disks for the computing instance will be provisioned on the host which it runs, otherwise SAN disks will be provisioned.
77+
* Specifies the disk type for the instance. When `true`, the disks for the computing instance will be provisioned on the host which it runs, otherwise SAN disks will be provisioned.
7678
* **Required**
7779
* `dedicated_acct_host_only` | *boolean*
7880
* Specifies whether or not the instance must only run on hosts with instances from the same account
7981
* *Default*: nil
8082
* *Optional*
8183
* `image` | *string*
8284
* An identifier for the operating system to provision the computing instance with.
83-
* **Conditionally required** - Disallowed when blockDeviceTemplateGroup.globalIdentifier is provided, as the template will specify the operating system.
85+
* **Conditionally required** - Disallowed when `blockDeviceTemplateGroup.globalIdentifier` is provided, as the template will specify the operating system.
8486
* `block_device_template_group_gid` | *string*
8587
* A global identifier for the template to be used to provision the computing instance.
86-
* **Conditionally required** - Disallowed when operatingSystemReferenceCode is provided, as the template will specify the operating system.
88+
* **Conditionally required** - Disallowed when `operatingSystemReferenceCode` is provided, as the template will specify the operating system.
8789
* `public_network_speed` | *int*
8890
* Specifies the connection speed for the instance's network components.
8991
* *Default*: 10
@@ -93,11 +95,11 @@ The following arguments are supported:
9395
* *Default*: False
9496
* *Optional*
9597
* `frontend_vlan_id` | *int*
96-
* Specifies the network vlan which is to be used for the frontend interface of the computing instance.
98+
* Specifies the network VLAN which is to be used for the front end interface of the computing instance.
9799
* *Default*: nil
98100
* *Optional*
99101
* `backend_vlan_id` | *int*
100-
* Specifies the network vlan which is to be used for the backend interface of the computing instance.
102+
* Specifies the network VLAN which is to be used for the back end interface of the computing instance.
101103
* *Default*: nil
102104
* *Optional*
103105
* `disks` | *array*
@@ -113,22 +115,21 @@ The following arguments are supported:
113115
* *Default*: nil
114116
* *Optional*
115117
* `ipv4_address` | *string*
116-
* Uses editObject call, template data [defined here](https://sldn.softlayer.com/reference/datatypes/SoftLayer_Virtual_Guest).
118+
* Uses `editObject` call, template data [defined here](https://sldn.softlayer.com/reference/datatypes/SoftLayer_Virtual_Guest).
117119
* *Default*: nil
118120
* *Optional*
119121
* `ipv4_address_private` | *string*
120-
* Uses editObject call, template data [defined here](https://sldn.softlayer.com/reference/datatypes/SoftLayer_Virtual_Guest).
122+
* Uses `editObject` call, template data [defined here](https://sldn.softlayer.com/reference/datatypes/SoftLayer_Virtual_Guest).
121123
* *Default*: nil
122124
* *Optional*
123125
* `post_install_script_uri` | *string*
124126
* As defined in the [SoftLayer_Virtual_Guest_SupplementalCreateObjectOptions](https://sldn.softlayer.com/reference/datatypes/SoftLayer_Virtual_Guest_SupplementalCreateObjectOptions).
125127
* *Default*: nil
126128
* *Optional*
127-
129+
128130
## Attributes Reference
129131

130-
The following attributes are exported:
132+
The following attributes are exported:
131133

132-
* `id` - id of the virtual guest.
134+
* `id` - The ID of the virtual guest.
133135

134-

0 commit comments

Comments
 (0)