Skip to content

Commit 2f32b11

Browse files
fix(site): fix agent and web terminal troubleshooting links (cherry-pick coder#16353) (coder#16405)
Co-authored-by: M Atif Ali <atif@coder.com>
1 parent a9775fa commit 2f32b11

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

cli/cliui/agent.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ func Agent(ctx context.Context, writer io.Writer, agentID uuid.UUID, opts AgentO
120120
if agent.Status == codersdk.WorkspaceAgentTimeout {
121121
now := time.Now()
122122
sw.Log(now, codersdk.LogLevelInfo, "The workspace agent is having trouble connecting, wait for it to connect or restart your workspace.")
123-
sw.Log(now, codersdk.LogLevelInfo, troubleshootingMessage(agent, fmt.Sprintf("%s/templates#agent-connection-issues", opts.DocsURL)))
123+
sw.Log(now, codersdk.LogLevelInfo, troubleshootingMessage(agent, fmt.Sprintf("%s/admin/templates/troubleshooting#agent-connection-issues", opts.DocsURL)))
124124
for agent.Status == codersdk.WorkspaceAgentTimeout {
125125
if agent, err = fetch(); err != nil {
126126
return xerrors.Errorf("fetch: %w", err)
@@ -225,13 +225,13 @@ func Agent(ctx context.Context, writer io.Writer, agentID uuid.UUID, opts AgentO
225225
sw.Fail(stage, safeDuration(sw, agent.ReadyAt, agent.StartedAt))
226226
// Use zero time (omitted) to separate these from the startup logs.
227227
sw.Log(time.Time{}, codersdk.LogLevelWarn, "Warning: A startup script exited with an error and your workspace may be incomplete.")
228-
sw.Log(time.Time{}, codersdk.LogLevelWarn, troubleshootingMessage(agent, fmt.Sprintf("%s/templates#startup-script-exited-with-an-error", opts.DocsURL)))
228+
sw.Log(time.Time{}, codersdk.LogLevelWarn, troubleshootingMessage(agent, fmt.Sprintf("%s/admin/templates/troubleshooting#startup-script-exited-with-an-error", opts.DocsURL)))
229229
default:
230230
switch {
231231
case agent.LifecycleState.Starting():
232232
// Use zero time (omitted) to separate these from the startup logs.
233233
sw.Log(time.Time{}, codersdk.LogLevelWarn, "Notice: The startup scripts are still running and your workspace may be incomplete.")
234-
sw.Log(time.Time{}, codersdk.LogLevelWarn, troubleshootingMessage(agent, fmt.Sprintf("%s/templates#your-workspace-may-be-incomplete", opts.DocsURL)))
234+
sw.Log(time.Time{}, codersdk.LogLevelWarn, troubleshootingMessage(agent, fmt.Sprintf("%s/admin/templates/troubleshooting#your-workspace-may-be-incomplete", opts.DocsURL)))
235235
// Note: We don't complete or fail the stage here, it's
236236
// intentionally left open to indicate this stage didn't
237237
// complete.
@@ -253,7 +253,7 @@ func Agent(ctx context.Context, writer io.Writer, agentID uuid.UUID, opts AgentO
253253
stage := "The workspace agent lost connection"
254254
sw.Start(stage)
255255
sw.Log(time.Now(), codersdk.LogLevelWarn, "Wait for it to reconnect or restart your workspace.")
256-
sw.Log(time.Now(), codersdk.LogLevelWarn, troubleshootingMessage(agent, fmt.Sprintf("%s/templates#agent-connection-issues", opts.DocsURL)))
256+
sw.Log(time.Now(), codersdk.LogLevelWarn, troubleshootingMessage(agent, fmt.Sprintf("%s/admin/templates/troubleshooting#agent-connection-issues", opts.DocsURL)))
257257

258258
disconnectedAt := agent.DisconnectedAt
259259
for agent.Status == codersdk.WorkspaceAgentDisconnected {

site/src/pages/TerminalPage/TerminalAlerts.tsx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,9 @@ export const ErrorScriptAlert: FC = () => {
7272
The workspace{" "}
7373
<Link
7474
title="startup script has exited with an error"
75-
href={docs("/templates#startup-script-exited-with-an-error")}
75+
href={docs(
76+
"/admin/templates/troubleshooting#startup-script-exited-with-an-error",
77+
)}
7678
target="_blank"
7779
rel="noreferrer"
7880
>

0 commit comments

Comments
 (0)