Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit ef6de5d

Browse files
matifalimatifali
committed
docs: update documentation links to remove version numbers
1 parent fecc5b3 commit ef6de5d

File tree

84 files changed

+188
-188
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+188
-188
lines changed

‎agent/agentscripts/agentscripts.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ func (r *Runner) run(ctx context.Context, script codersdk.WorkspaceAgentScript)
349349
"This usually means a child process was started with references to stdout or stderr. As a result, this " +
350350
"process may now have been terminated. Consider redirecting the output or using a separate " +
351351
"\"coder_script\" for the process, see " +
352-
"https://coder.com/docs/v2/latest/templates/troubleshooting#startup-script-issues for more information.",
352+
"https://coder.com/docs/templates/troubleshooting#startup-script-issues for more information.",
353353
)
354354
// Inform the user by propagating the message via log writers.
355355
_, _ = fmt.Fprintf(cmd.Stderr, "WARNING: %s. %s\n", message, details)

‎cli/cliui/agent.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ func Agent(ctx context.Context, writer io.Writer, agentID uuid.UUID, opts AgentO
116116
if agent.Status == codersdk.WorkspaceAgentTimeout {
117117
now := time.Now()
118118
sw.Log(now, codersdk.LogLevelInfo, "The workspace agent is having trouble connecting, wait for it to connect or restart your workspace.")
119-
sw.Log(now, codersdk.LogLevelInfo, troubleshootingMessage(agent, "https://coder.com/docs/v2/latest/templates#agent-connection-issues"))
119+
sw.Log(now, codersdk.LogLevelInfo, troubleshootingMessage(agent, "https://coder.com/docs/templates#agent-connection-issues"))
120120
for agent.Status == codersdk.WorkspaceAgentTimeout {
121121
if agent, err = fetch(); err != nil {
122122
return xerrors.Errorf("fetch: %w", err)
@@ -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/troubleshooting#startup-script-exited-with-an-error"))
215+
sw.Log(time.Time{}, codersdk.LogLevelWarn, troubleshootingMessage(agent, "https://coder.com/docs/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/troubleshooting#your-workspace-may-be-incomplete"))
221+
sw.Log(time.Time{}, codersdk.LogLevelWarn, troubleshootingMessage(agent, "https://coder.com/docs/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/troubleshooting#agent-connection-issues"))
243+
sw.Log(time.Now(), codersdk.LogLevelWarn, troubleshootingMessage(agent, "https://coder.com/docs/templates/troubleshooting#agent-connection-issues"))
244244

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

‎cli/dotfiles.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ func (r *RootCmd) dotfiles() *serpent.Command {
204204
}
205205

206206
if fi.Mode()&0o111 == 0 {
207-
return xerrors.Errorf("script %q is not executable. See https://coder.com/docs/v2/latest/dotfiles for information on how to resolve the issue.", script)
207+
return xerrors.Errorf("script %q is not executable. See https://coder.com/docs/dotfiles for information on how to resolve the issue.", script)
208208
}
209209

210210
// it is safe to use a variable command here because it's from

‎cli/server.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -830,7 +830,7 @@ func (r *RootCmd) Server(newAPI func(context.Context, *coderd.Options) (*coderd.
830830
}
831831
defer options.Telemetry.Close()
832832
} else {
833-
logger.Warn(ctx, `telemetry disabled, unable to notify of security issues. Read more: https://coder.com/docs/v2/latest/admin/telemetry`)
833+
logger.Warn(ctx, `telemetry disabled, unable to notify of security issues. Read more: https://coder.com/docs/admin/telemetry`)
834834
}
835835

836836
// This prevents the pprof import from being accidentally deleted.

‎coderd/healthcheck/health/model_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ func Test_MessageURL(t *testing.T) {
1717
base string
1818
expected string
1919
}{
20-
{"empty", "", "", "https://coder.com/docs/v2/latest/admin/healthcheck#eunknown"},
21-
{"default", health.CodeAccessURLFetch, "", "https://coder.com/docs/v2/latest/admin/healthcheck#eacs03"},
20+
{"empty", "", "", "https://coder.com/docs/admin/healthcheck#eunknown"},
21+
{"default", health.CodeAccessURLFetch, "", "https://coder.com/docs/admin/healthcheck#eacs03"},
2222
{"custom docs base", health.CodeAccessURLFetch, "https://example.com/docs", "https://example.com/docs/admin/healthcheck#eacs03"},
2323
} {
2424
tt := tt

‎codersdk/deployment.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1781,7 +1781,7 @@ when required by your organization's security policy.`,
17811781
Flag: "agent-fallback-troubleshooting-url",
17821782
Env: "CODER_AGENT_FALLBACK_TROUBLESHOOTING_URL",
17831783
Hidden: true,
1784-
Default: "https://coder.com/docs/v2/latest/templates/troubleshooting",
1784+
Default: "https://coder.com/docs/templates/troubleshooting",
17851785
Value: &c.AgentFallbackTroubleshootingURL,
17861786
YAML: "agentFallbackTroubleshootingURL",
17871787
},

‎codersdk/healthsdk/healthsdk_test.go

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,22 +41,22 @@ func TestSummarize(t *testing.T) {
4141
expected := []string{
4242
"Access URL: Error: test error",
4343
"Access URL: Warn: TEST: testing",
44-
"See: https://coder.com/docs/v2/latest/admin/healthcheck#test",
44+
"See: https://coder.com/docs/admin/healthcheck#test",
4545
"Database: Error: test error",
4646
"Database: Warn: TEST: testing",
47-
"See: https://coder.com/docs/v2/latest/admin/healthcheck#test",
47+
"See: https://coder.com/docs/admin/healthcheck#test",
4848
"DERP: Error: test error",
4949
"DERP: Warn: TEST: testing",
50-
"See: https://coder.com/docs/v2/latest/admin/healthcheck#test",
50+
"See: https://coder.com/docs/admin/healthcheck#test",
5151
"Provisioner Daemons: Error: test error",
5252
"Provisioner Daemons: Warn: TEST: testing",
53-
"See: https://coder.com/docs/v2/latest/admin/healthcheck#test",
53+
"See: https://coder.com/docs/admin/healthcheck#test",
5454
"Websocket: Error: test error",
5555
"Websocket: Warn: TEST: testing",
56-
"See: https://coder.com/docs/v2/latest/admin/healthcheck#test",
56+
"See: https://coder.com/docs/admin/healthcheck#test",
5757
"Workspace Proxies: Error: test error",
5858
"Workspace Proxies: Warn: TEST: testing",
59-
"See: https://coder.com/docs/v2/latest/admin/healthcheck#test",
59+
"See: https://coder.com/docs/admin/healthcheck#test",
6060
}
6161
actual := hr.Summarize("")
6262
assert.Equal(t, expected, actual)
@@ -93,9 +93,9 @@ func TestSummarize(t *testing.T) {
9393
expected: []string{
9494
"Error: testing",
9595
"Warn: TEST01: testing one",
96-
"See: https://coder.com/docs/v2/latest/admin/healthcheck#test01",
96+
"See: https://coder.com/docs/admin/healthcheck#test01",
9797
"Warn: TEST02: testing two",
98-
"See: https://coder.com/docs/v2/latest/admin/healthcheck#test02",
98+
"See: https://coder.com/docs/admin/healthcheck#test02",
9999
},
100100
},
101101
{
@@ -117,9 +117,9 @@ func TestSummarize(t *testing.T) {
117117
expected: []string{
118118
"TEST: Error: testing",
119119
"TEST: Warn: TEST01: testing one",
120-
"See: https://coder.com/docs/v2/latest/admin/healthcheck#test01",
120+
"See: https://coder.com/docs/admin/healthcheck#test01",
121121
"TEST: Warn: TEST02: testing two",
122-
"See: https://coder.com/docs/v2/latest/admin/healthcheck#test02",
122+
"See: https://coder.com/docs/admin/healthcheck#test02",
123123
},
124124
},
125125
} {

‎docs/admin/auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ OIDC provider will be added to the `myCoderGroupName` group in Coder.
321321
### Group allowlist
322322

323323
You can limit which groups from your identity provider can log in to Coder with
324-
[CODER_OIDC_ALLOWED_GROUPS](https://coder.com/docs/v2/latest/cli/server#--oidc-allowed-groups).
324+
[CODER_OIDC_ALLOWED_GROUPS](https://coder.com/docs/cli/server#--oidc-allowed-groups).
325325
Users who are not in a matching group will see the following error:
326326

327327
![Unauthorized group error](../images/admin/group-allowlist.png)

‎docs/admin/external-auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ CODER_EXTERNAL_AUTH_0_REGEX=github\.company\.org
185185
### JFrog Artifactory
186186

187187
See
188-
[this](https://coder.com/docs/v2/latest/guides/artifactory-integration#jfrog-oauth)
188+
[this](https://coder.com/docs/guides/artifactory-integration#jfrog-oauth)
189189
guide on instructions on how to set up for JFrog Artifactory.
190190

191191
### Custom scopes

‎docs/architecture/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@ project-oriented [features](https://containers.dev/features) without requiring
357357
platform administrators to push altered Docker images.
358358

359359
Learn more about
360-
[Dev containers support](https://coder.com/docs/v2/latest/templates/dev-containers)
360+
[Dev containers support](https://coder.com/docs/templates/dev-containers)
361361
in Coder.
362362

363363
![Architecture Diagram](../images/architecture-devcontainers.png)

0 commit comments

Comments
 (0)