Skip to content

docs: fix formatting of note callouts #16761

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 7, 2025
Merged

docs: fix formatting of note callouts #16761

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ae00187
docs: fix formatting of note callouts
lucasmelin Mar 2, 2025
c2aa359
docs: replace GitHub-style note callouts with blockquotes
lucasmelin Mar 3, 2025
225c08b
docs: switch back to GitHub-style note callouts
lucasmelin Mar 5, 2025
0fe27ed
chore: regenerate examples.gen.json
lucasmelin Mar 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: switch back to GitHub-style note callouts 
This reverts commit c2aa359.
  • Loading branch information
@lucasmelin
lucasmelin committed Mar 5, 2025
commit 225c08b99a0a7bc4933d37f8b2fa8d04a219e316
30 changes: 12 additions & 18 deletions docs/admin/provisioners.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,13 +166,10 @@ inside the Terraform. See the
[workspace tags documentation](../admin/templates/extending-templates/workspace-tags.md)
for more information.

<blockquote class="admonition note">

Workspace tags defined with the `coder_workspace_tags` data source
template **do not** automatically apply to the template import job! You may
need to specify the desired tags when importing the template.

</blockquote>
> [!NOTE]
> Workspace tags defined with the `coder_workspace_tags` data source
> template **do not** automatically apply to the template import job! You may
> need to specify the desired tags when importing the template.

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

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

<blockquote class="admonition note">

If you only run tagged provisioners, you will need to specify a set of
tags that matches at least one provisioner for _all_ template import jobs and
workspace build jobs.

You may wish to run at least one additional provisioner with no additional
tags so that provisioner jobs with no additional tags defined will be picked
up instead of potentially remaining in the Pending state indefinitely.

</blockquote>
> [!NOTE]
> If you only run tagged provisioners, you will need to specify a set of
> tags that matches at least one provisioner for _all_ template import jobs and
> workspace build jobs.
>
> You may wish to run at least one additional provisioner with no additional
> tags so that provisioner jobs with no additional tags defined will be picked
> up instead of potentially remaining in the Pending state indefinitely.

This is illustrated in the below table:

Expand Down
53 changes: 25 additions & 28 deletions docs/admin/templates/extending-templates/parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,34 +79,31 @@ data "coder_parameter" "security_groups" {
}
```

<blockquote class="admonition note">

Overriding a `list(string)` on the CLI is tricky because:

- `--parameter "parameter_name=parameter_value"` is parsed as CSV.
- `parameter_value` is parsed as JSON.

So, to properly specify a `list(string)` with the `--parameter` CLI argument,
you will need to take care of both CSV quoting and shell quoting.

For the above example, to override the default values of the `security_groups`
parameter, you will need to pass the following argument to `coder create`:

```shell
--parameter "\"security_groups=[\"\"DevOps Security Group\"\",\"\"Backend Security Group\"\"]\""
```

Alternatively, you can use `--rich-parameter-file` to work around the above
issues. This allows you to specify parameters as YAML. An equivalent parameter
file for the above `--parameter` is provided below:

```yaml
security_groups:
- DevOps Security Group
- Backend Security Group
```

</blockquote>
> [!NOTE]
> Overriding a `list(string)` on the CLI is tricky because:
>
> - `--parameter "parameter_name=parameter_value"` is parsed as CSV.
> - `parameter_value` is parsed as JSON.
>
> So, to properly specify a `list(string)` with the `--parameter` CLI argument,
> you will need to take care of both CSV quoting and shell quoting.
>
> For the above example, to override the default values of the `security_groups`
> parameter, you will need to pass the following argument to `coder create`:
>
> ```shell
> --parameter "\"security_groups=[\"\"DevOps Security Group\"\",\"\"Backend Security Group\"\"]\""
> ```
>
> Alternatively, you can use `--rich-parameter-file` to work around the above
> issues. This allows you to specify parameters as YAML. An equivalent parameter
> file for the above `--parameter` is provided below:
>
> ```yaml
> security_groups:
> - DevOps Security Group
> - Backend Security Group
> ```

## Options

Expand Down
Loading