Skip to content

Commit e67b6d3

Browse files
authored
Fix colons on documentation callouts (#261)
1 parent 813894e commit e67b6d3

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

docs/guides/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ resource "iterative_task" "example" {
3737
}
3838
```
3939

40-
-> **Note**: The `script` argument can take anny string, including a [heredoc](https://www.terraform.io/docs/language/expressions/strings.html#heredoc-strings) or the contents of a file returned by the [`file`](https://www.terraform.io/docs/language/functions/file.html) function.
40+
-> **Note:** The `script` argument can take anny string, including a [heredoc](https://www.terraform.io/docs/language/expressions/strings.html#heredoc-strings) or the contents of a file returned by the [`file`](https://www.terraform.io/docs/language/functions/file.html) function.
4141

4242
The project layout should look similar to this:
4343

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ $ terraform apply
5151

5252
- `GOOGLE_APPLICATION_CREDENTIALS` - Path to a service account JSON key file.
5353

54-
-> **Note** you can also use `GOOGLE_APPLICATION_CREDENTIALS_DATA` with the
54+
-> **Note:** you can also use `GOOGLE_APPLICATION_CREDENTIALS_DATA` with the
5555
**contents** of the service account JSON key file.
5656

5757
### Microsoft Azure
@@ -65,4 +65,4 @@ $ terraform apply
6565

6666
- `KUBECONFIG` - Path to a [`kubeconfig` file](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#the-kubeconfig-environment-variable).
6767

68-
-> **Note**: You can use `KUBECONFIG_DATA` instead, with the **contents** of the `kubeconfig` file.
68+
-> **Note:** You can use `KUBECONFIG_DATA` instead, with the **contents** of the `kubeconfig` file.

docs/resources/task.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ In addition to all arguments above, the following attributes are exported:
5454
- `events` - List of events for the machine orchestrator.
5555
- `logs` - List with task logs; one for each machine.
5656

57-
~> **Note**: Status and events don't produce a stable output between cloud providers and are intended for human consumption only.
57+
~> **Note:** Status and events don't produce a stable output between cloud providers and are intended for human consumption only.
5858

5959
## Machine Type
6060

@@ -104,9 +104,9 @@ supported by the underlying cloud provider.
104104
- `{cpu}-{memory}` - Any [CPU & memory combination](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers) (e.g. `64-256000`).
105105
- `{cpu}-{memory}+{accelerator}*{count}` - Any CPU, memory, & [accelerator](https://kubernetes.io/docs/tasks/manage-gpus/scheduling-gpus) combination (e.g. `64-256000+nvidia-tesla-k80*1`).
106106

107-
-> **Note**: Specified resource amounts are considered **limits** (rather than **requests**).
107+
-> **Note:** Specified resource amounts are considered **limits** (rather than **requests**).
108108

109-
-> **Note**: `{accelerator}` will be transformed into a node selector requesting `accelerator={accelerator}` and `{count}` will be configured as the **limits** count for `kubernetes.io/gpu`.
109+
-> **Note:** `{accelerator}` will be transformed into a node selector requesting `accelerator={accelerator}` and `{count}` will be configured as the **limits** count for `kubernetes.io/gpu`.
110110

111111
## Machine Images
112112

@@ -210,6 +210,6 @@ Setting the `region` attribute results in undefined behaviour.
210210

211211
Unlike public cloud providers, Kubernetes does not offer any portable way of persisting and sharing storage between pods. When specified, the `directory` attribute will create a `PersistentVolumeClaim` of the default `StorageClass`, with the same lifecycle as the task and the specified `disk_size`.
212212

213-
~> **Warning**: Access mode will be `ReadWriteOnce` for `parallelism` equal to 1 or `ReadWriteMany` otherwise.
213+
~> **Warning:** Access mode will be `ReadWriteOnce` for `parallelism` equal to 1 or `ReadWriteMany` otherwise.
214214

215-
-> **Note**: Rancher's [Local Path Provisioner](https://github.com/rancher/local-path-provisioner) might be the easiest way of deploying a quick `ReadWriteOnce` dynamically allocated storage solution for testing: just run `kubectl apply -f https://raw.githubusercontent.com/rancher/local-path-provisioner/master/deploy/local-path-storage.yaml`.
215+
-> **Note:** Rancher's [Local Path Provisioner](https://github.com/rancher/local-path-provisioner) might be the easiest way of deploying a quick `ReadWriteOnce` dynamically allocated storage solution for testing: just run `kubectl apply -f https://raw.githubusercontent.com/rancher/local-path-provisioner/master/deploy/local-path-storage.yaml`.

0 commit comments

Comments
 (0)