Skip to content

Commit 53b58ed

Browse files
authored
fix: correct troubleshooting links (coder#12608)
1 parent 5011edc commit 53b58ed

File tree

3 files changed

+6
-8
lines changed

3 files changed

+6
-8
lines changed

cli/cliui/agent.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -212,13 +212,13 @@ func Agent(ctx context.Context, writer io.Writer, agentID uuid.UUID, opts AgentO
212212
sw.Fail(stage, safeDuration(sw, agent.ReadyAt, agent.StartedAt))
213213
// Use zero time (omitted) to separate these from the startup logs.
214214
sw.Log(time.Time{}, codersdk.LogLevelWarn, "Warning: A startup script exited with an error and your workspace may be incomplete.")
215-
sw.Log(time.Time{}, codersdk.LogLevelWarn, troubleshootingMessage(agent, "https://coder.com/docs/v2/latest/templates#startup-script-exited-with-an-error"))
215+
sw.Log(time.Time{}, codersdk.LogLevelWarn, troubleshootingMessage(agent, "https://coder.com/docs/v2/latest/templates/troubleshooting#startup-script-exited-with-an-error"))
216216
default:
217217
switch {
218218
case agent.LifecycleState.Starting():
219219
// Use zero time (omitted) to separate these from the startup logs.
220220
sw.Log(time.Time{}, codersdk.LogLevelWarn, "Notice: The startup scripts are still running and your workspace may be incomplete.")
221-
sw.Log(time.Time{}, codersdk.LogLevelWarn, troubleshootingMessage(agent, "https://coder.com/docs/v2/latest/templates#your-workspace-may-be-incomplete"))
221+
sw.Log(time.Time{}, codersdk.LogLevelWarn, troubleshootingMessage(agent, "https://coder.com/docs/v2/latest/templates/troubleshooting#your-workspace-may-be-incomplete"))
222222
// Note: We don't complete or fail the stage here, it's
223223
// intentionally left open to indicate this stage didn't
224224
// complete.
@@ -240,7 +240,7 @@ func Agent(ctx context.Context, writer io.Writer, agentID uuid.UUID, opts AgentO
240240
stage := "The workspace agent lost connection"
241241
sw.Start(stage)
242242
sw.Log(time.Now(), codersdk.LogLevelWarn, "Wait for it to reconnect or restart your workspace.")
243-
sw.Log(time.Now(), codersdk.LogLevelWarn, troubleshootingMessage(agent, "https://coder.com/docs/v2/latest/templates#agent-connection-issues"))
243+
sw.Log(time.Now(), codersdk.LogLevelWarn, troubleshootingMessage(agent, "https://coder.com/docs/v2/latest/templates/troubleshooting#agent-connection-issues"))
244244

245245
disconnectedAt := agent.DisconnectedAt
246246
for agent.Status == codersdk.WorkspaceAgentDisconnected {

cli/testdata/server-config.yaml.golden

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -416,10 +416,8 @@ inMemoryDatabase: false
416416
# (default: ed25519, type: string)
417417
sshKeygenAlgorithm: ed25519
418418
# URL to use for agent troubleshooting when not set in the template.
419-
# (default:
420-
# https://coder.com/docs/coder-oss/latest/templates#troubleshooting-templates,
421-
# type: url)
422-
agentFallbackTroubleshootingURL: https://coder.com/docs/coder-oss/latest/templates#troubleshooting-templates
419+
# (default: https://coder.com/docs/v2/latest/templates/troubleshooting, type: url)
420+
agentFallbackTroubleshootingURL: https://coder.com/docs/v2/latest/templates/troubleshooting
423421
# Disable workspace apps that are not served from subdomains. Path-based apps can
424422
# make requests to the Coder API and pose a security risk when the workspace
425423
# serves malicious JavaScript. This is recommended for security purposes if a

codersdk/deployment.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1699,7 +1699,7 @@ when required by your organization's security policy.`,
16991699
Flag: "agent-fallback-troubleshooting-url",
17001700
Env: "CODER_AGENT_FALLBACK_TROUBLESHOOTING_URL",
17011701
Hidden: true,
1702-
Default: "https://coder.com/docs/coder-oss/latest/templates#troubleshooting-templates",
1702+
Default: "https://coder.com/docs/v2/latest/templates/troubleshooting",
17031703
Value: &c.AgentFallbackTroubleshootingURL,
17041704
YAML: "agentFallbackTroubleshootingURL",
17051705
},

0 commit comments

Comments
 (0)