Skip to content

Commit 1aee589

Browse files
docs(admin/templates/): fix terraform provider links (#16338)
1 parent 3a179e9 commit 1aee589

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

docs/admin/templates/extending-templates/workspace-tags.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ added that can handle its combination of tags.
7171
Before releasing the template version with configurable workspace tags, ensure
7272
that every tag set is associated with at least one healthy provisioner.
7373

74-
> [!NOTE] It may be useful to run at least one provisioner with no additional
74+
> **Note:** It may be useful to run at least one provisioner with no additional
7575
> tag restrictions that is able to take on any job.
7676
7777
### Parameters types

docs/admin/templates/troubleshooting.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Occasionally, you may run into scenarios where a workspace is created, but the
44
agent is either not connected or the
5-
[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script)
5+
[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script-1)
66
has failed or timed out.
77

88
## Agent connection issues
@@ -36,18 +36,18 @@ practices:
3636
## Startup script issues
3737

3838
Depending on the contents of the
39-
[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script),
39+
[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script-1),
4040
and whether or not the
41-
[startup script behavior](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script_behavior)
41+
[startup script behavior](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script_behavior-1)
4242
is set to blocking or non-blocking, you may notice issues related to the startup
4343
script. In this section we will cover common scenarios and how to resolve them.
4444

4545
### Unable to access workspace, startup script is still running
4646

4747
If you're trying to access your workspace and are unable to because the
48-
[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script)
48+
[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script-1)
4949
is still running, it means the
50-
[startup script behavior](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script_behavior)
50+
[startup script behavior](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script_behavior-1)
5151
option is set to blocking or you have enabled the `--wait=yes` option (for e.g.
5252
`coder ssh` or `coder config-ssh`). In such an event, you can always access the
5353
workspace by using the web terminal, or via SSH using the `--wait=no` option. If
@@ -58,13 +58,13 @@ terminating processes started by it or terminating the startup script itself (on
5858
Linux, `ps` and `kill` are useful tools).
5959

6060
For tips on how to write a startup script that doesn't run forever, see the
61-
[`startup_script`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script)
61+
[`startup_script`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script-1)
6262
section. For more ways to override the startup script behavior, see the
63-
[`startup_script_behavior`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script_behavior)
63+
[`startup_script_behavior`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script_behavior-1)
6464
section.
6565

6666
Template authors can also set the
67-
[startup script behavior](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script_behavior)
67+
[startup script behavior](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script_behavior-1)
6868
option to non-blocking, which will allow users to access the workspace while the
6969
startup script is still running. Note that the workspace must be updated after
7070
changing this option.
@@ -74,7 +74,7 @@ changing this option.
7474
If you see a warning that your workspace may be incomplete, it means you should
7575
be aware that programs, files, or settings may be missing from your workspace.
7676
This can happen if the
77-
[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script)
77+
[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script-1)
7878
is still running or has exited with a non-zero status (see
7979
[startup script error](#startup-script-exited-with-an-error)). No action is
8080
necessary, but you may want to
@@ -86,7 +86,7 @@ issues.
8686
### Session was started before the startup script finished
8787

8888
The web terminal may show this message if it was started before the
89-
[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script)
89+
[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script-1)
9090
finished, but the startup script has since finished. This message can safely be
9191
dismissed, however, be aware that your preferred shell or dotfiles may not yet
9292
be activated for this shell session. You can either start a new session or
@@ -102,7 +102,7 @@ Examples for activating your preferred shell or sourcing your dotfiles:
102102
### Startup script exited with an error
103103

104104
When the
105-
[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script)
105+
[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script-1)
106106
exits with an error, it means the last command run by the script failed. When
107107
`set -e` is used, this means that any failing command will immediately exit the
108108
script and the remaining commands will not be executed. This also means that
@@ -120,7 +120,7 @@ Common causes for startup script errors:
120120
### Debugging the startup script
121121

122122
The simplest way to debug the
123-
[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script)
123+
[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script-1)
124124
is to open the workspace in the Coder dashboard and click "Show startup log" (if
125125
not already visible). This will show all the output from the script. Another
126126
option is to view the log file inside the workspace (usually

0 commit comments

Comments
 (0)