8000 docs: replace GitHub-style note callouts with blockquotes · lucasmelin/coder@c2aa359 · GitHub
[go: up one dir, main page]
Skip to content
10000

Commit c2aa359

Browse files
lucasmelinlucasmelin
committed
docs: replace GitHub-style note callouts with blockquotes
1 parent ae00187 commit c2aa359

File tree

2 files changed

+46
-37
lines changed

2 files changed

+46
-37
lines changed

‎docs/admin/provisioners.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -166,10 +166,13 @@ inside the Terraform. See the
166166
[workspace tags documentation](../admin/templates/extending-templates/workspace-tags.md)
167167
for more information.
168168

169-
> [!NOTE]
170-
> Workspace tags defined with the `coder_workspace_tags` data source
171-
> template **do not** automatically apply to the template import job! You may
172-
> need to specify the desired tags when importing the template.
169+
<blockquote class="admonition note">
170+
171+
Workspace tags defined with the `coder_workspace_tags` data source
172+
template **do not** automatically apply to the template import job! You may
173+
need to specify the desired tags when importing the template.
174+
175+
</blockquote>
173176

174177
A provisioner can run a given build job if one of the below is true:
175178

@@ -191,14 +194,17 @@ However, it will not pick up any build jobs that do not have either of the
191194
from templates with the tag `scope=user` set, or build jobs from templates in
192195
different organizations.
193196

194-
> [!NOTE]
195-
> If you only run tagged provisioners, you will need to specify a set of
196-
> tags that matches at least one provisioner for _all_ template import jobs and
197-
> workspace build jobs.
198-
>
199-
> You may wish to run at least one additional provisioner with no additional
200-
> tags so that provisioner jobs with no additional tags defined will be picked
201-
> up instead of potentially remaining in the Pending state indefinitely.
197+
<blockquote class="admonition note">
198+
199+
If you only run tagged provisioners, you will need to specify a set of
200+
tags that matches at least one provisioner for _all_ template import jobs and
201+
workspace build jobs.
202+
203+
You may wish to run at least one additional provisioner with no additional
204+
tags so that provisioner jobs with no additional tags defined will be picked
205+
up instead of potentially remaining in the Pending state indefinitely.
206+
207+
</blockquote>
202208

203209
This is illustrated in the below table:
204210

‎docs/admin/templates/extending-templates/parameters.md

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -79,31 +79,34 @@ data "coder_parameter" "security_groups" {
7979
}
8080
```
8181

82-
> [!NOTE]
83-
> Overriding a `list(string)` on the CLI is tricky because:
84-
>
85-
> - `--parameter "parameter_name=parameter_value"` is parsed as CSV.
86-
> - `parameter_value` is parsed as JSON.
87-
>
88-
> So, to properly specify a `list(string)` with the `--parameter` CLI argument,
89-
> you will need to take care of both CSV quoting and shell quoting.
90-
>
91-
> For the above example, to override the default values of the `security_groups`
92-
> parameter, you will need to pass the following argument to `coder create`:
93-
>
94-
> ```shell
95-
> --parameter "\"security_groups=[\"\"DevOps Security Group\"\",\"\"Backend Security Group\"\"]\""
96-
> ```
97-
>
98-
> Alternatively, you can use `--rich-parameter-file` to work around the above
99-
> issues. This allows you to specify parameters as YAML. An equivalent parameter
100-
> file for the above `--parameter` is provided below:
101-
>
102-
> ```yaml
103-
> security_groups:
104-
> - DevOps Security Group
105-
> - Backend Security Group
106-
> ```
82+
<blockquote class="admonition note">
83+
84+
Overriding a `list(string)` on the CLI is tricky because:
85+
86+
- `--parameter "parameter_name=parameter_value"` is parsed as CSV.
87+
- `parameter_value` is parsed as JSON.
88+
89+
So, to properly specify a `list(string)` with the `--parameter` CLI argument,
90+
you will need to take care of both CSV quoting and shell quoting.
91+
92+
For the above example, to override the default values of the `security_groups`
93+
parameter, you will need to pass the following argument to `coder create`:
94+
95+
```shell
96+
--parameter "\"security_groups=[\"\"DevOps Security Group\"\",\"\"Backend Security Group\"\"]\""
97+
```
98+
99+
Alternatively, you can use `--rich-parameter-file` to work around the above
100+
issues. This allows you to specify parameters as YAML. An equivalent parameter
101+
file for the above `--parameter` is provided below:
102+
103+
```yaml
104+
security_groups:
105+
- DevOps Security Group
106+
- Backend Security Group
107+
```
108+
109+
</blockquote>
107110
108111
## Options
109112

0 commit comments

Comments
 (0)
0