Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit0787de8

Browse files
authored
chore: update documentation links to the new format (#13797)
1 parent2a297b0 commit0787de8

File tree

87 files changed

+213
-222
lines changed

Some content is hidden

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

87 files changed

+213
-222
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
ifagent.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
foragent.Status==codersdk.WorkspaceAgentTimeout {
121121
ifagent,err=fetch();err!=nil {
122122
returnxerrors.Errorf("fetch: %w",err)
@@ -221,13 +221,13 @@ func Agent(ctx context.Context, writer io.Writer, agentID uuid.UUID, opts AgentO
221221
sw.Fail(stage,safeDuration(sw,agent.ReadyAt,agent.StartedAt))
222222
// Use zero time (omitted) to separate these from the startup logs.
223223
sw.Log(time.Time{},codersdk.LogLevelWarn,"Warning: A startup script exited with an error and your workspace may be incomplete.")
224-
sw.Log(time.Time{},codersdk.LogLevelWarn,troubleshootingMessage(agent,"https://coder.com/docs/v2/latest/templates/troubleshooting#startup-script-exited-with-an-error"))
224+
sw.Log(time.Time{},codersdk.LogLevelWarn,troubleshootingMessage(agent,"https://coder.com/docs/templates/troubleshooting#startup-script-exited-with-an-error"))
225225
default:
226226
switch {
227227
caseagent.LifecycleState.Starting():
228228
// Use zero time (omitted) to separate these from the startup logs.
229229
sw.Log(time.Time{},codersdk.LogLevelWarn,"Notice: The startup scripts are still running and your workspace may be incomplete.")
230-
sw.Log(time.Time{},codersdk.LogLevelWarn,troubleshootingMessage(agent,"https://coder.com/docs/v2/latest/templates/troubleshooting#your-workspace-may-be-incomplete"))
230+
sw.Log(time.Time{},codersdk.LogLevelWarn,troubleshootingMessage(agent,"https://coder.com/docs/templates/troubleshooting#your-workspace-may-be-incomplete"))
231231
// Note: We don't complete or fail the stage here, it's
232232
// intentionally left open to indicate this stage didn't
233233
// complete.
@@ -249,7 +249,7 @@ func Agent(ctx context.Context, writer io.Writer, agentID uuid.UUID, opts AgentO
249249
stage:="The workspace agent lost connection"
250250
sw.Start(stage)
251251
sw.Log(time.Now(),codersdk.LogLevelWarn,"Wait for it to reconnect or restart your workspace.")
252-
sw.Log(time.Now(),codersdk.LogLevelWarn,troubleshootingMessage(agent,"https://coder.com/docs/v2/latest/templates/troubleshooting#agent-connection-issues"))
252+
sw.Log(time.Now(),codersdk.LogLevelWarn,troubleshootingMessage(agent,"https://coder.com/docs/templates/troubleshooting#agent-connection-issues"))
253253

254254
disconnectedAt:=agent.DisconnectedAt
255255
foragent.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
iffi.Mode()&0o111==0 {
207-
returnxerrors.Errorf("script %q is not executable. See https://coder.com/docs/v2/latest/dotfiles for information on how to resolve the issue.",script)
207+
returnxerrors.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
@@ -838,7 +838,7 @@ func (r *RootCmd) Server(newAPI func(context.Context, *coderd.Options) (*coderd.
838838
}
839839
deferoptions.Telemetry.Close()
840840
}else {
841-
logger.Warn(ctx,`telemetry disabled, unable to notify of security issues. Read more: https://coder.com/docs/v2/latest/admin/telemetry`)
841+
logger.Warn(ctx,`telemetry disabled, unable to notify of security issues. Read more: https://coder.com/docs/admin/telemetry`)
842842
}
843843

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

‎cli/testdata/server-config.yaml.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -427,8 +427,8 @@ termsOfServiceURL: ""
427427
# (default: ed25519, type: string)
428428
sshKeygenAlgorithm: ed25519
429429
# URL to use for agent troubleshooting when not set in the template.
430-
# (default: https://coder.com/docs/v2/latest/templates/troubleshooting, type: url)
431-
agentFallbackTroubleshootingURL: https://coder.com/docs/v2/latest/templates/troubleshooting
430+
# (default: https://coder.com/docs/templates/troubleshooting, type: url)
431+
agentFallbackTroubleshootingURL: https://coder.com/docs/templates/troubleshooting
432432
# Disable workspace apps that are not served from subdomains. Path-based apps can
433433
# make requests to the Coder API and pose a security risk when the workspace
434434
# serves malicious JavaScript. This is recommended for security purposes if a

‎coderd/healthcheck/health/model.go

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ import (
44
"fmt"
55
"strings"
66

7-
"github.com/coder/coder/v2/buildinfo"
87
"github.com/coder/coder/v2/coderd/util/ptr"
98
)
109

@@ -49,7 +48,7 @@ const (
4948

5049
// Default docs URL
5150
var (
52-
docsURLDefault="https://coder.com/docs/v2"
51+
docsURLDefault="https://coder.com/docs"
5352
)
5453

5554
// @typescript-generate Severity
@@ -92,12 +91,7 @@ func (m Message) URL(base string) string {
9291

9392
ifbase=="" {
9493
base=docsURLDefault
95-
versionPath:=buildinfo.Version()
96-
ifbuildinfo.IsDev() {
97-
// for development versions, just use latest
98-
versionPath="latest"
99-
}
100-
returnfmt.Sprintf("%s/%s/admin/healthcheck#%s",base,versionPath,codeAnchor)
94+
returnfmt.Sprintf("%s/admin/healthcheck#%s",base,codeAnchor)
10195
}
10296

10397
// We don't assume that custom docs URLs are versioned.

‎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
basestring
1818
expectedstring
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
@@ -1867,7 +1867,7 @@ when required by your organization's security policy.`,
18671867
Flag:"agent-fallback-troubleshooting-url",
18681868
Env:"CODER_AGENT_FALLBACK_TROUBLESHOOTING_URL",
18691869
Hidden:true,
1870-
Default:"https://coder.com/docs/v2/latest/templates/troubleshooting",
1870+
Default:"https://coder.com/docs/templates/troubleshooting",
18711871
Value:&c.AgentFallbackTroubleshootingURL,
18721872
YAML:"agentFallbackTroubleshootingURL",
18731873
},

‎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 & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -184,8 +184,7 @@ CODER_EXTERNAL_AUTH_0_REGEX=github\.company\.org
184184
185185
###JFrog Artifactory
186186

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

191190
###Custom scopes

‎docs/architecture/architecture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -357,8 +357,8 @@ 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)
361-
inCoder.
360+
[Dev containers support](https://coder.com/docs/templates/dev-containers) in
361+
Coder.
362362

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

‎docs/changelogs/v0.25.0.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
- The`coder stat` fetches workspace utilization metrics, even from within a
99
container. Our example templates have been updated to use this to show CPU,
1010
memory, disk via
11-
[agent metadata](https://coder.com/docs/v2/latest/templates/agent-metadata)
11+
[agent metadata](https://coder.com/docs/templates/agent-metadata)
1212
(#8005)
1313
- Helm:`coder.command` can specify a different command for the Coder pod
1414
(#8116)
@@ -20,7 +20,7 @@
2020
- Healthcheck endpoint has a database section:`/api/v2/debug/health`
2121
- Force DERP connections in CLI with`--disable-direct` flag (#8131)
2222
- Disable all direct connections for a Coder deployment with
23-
[--block-direct-connections](https://coder.com/docs/v2/latest/cli/server#--block-direct-connections)
23+
[--block-direct-connections](https://coder.com/docs/cli/server#--block-direct-connections)
2424
(#7936)
2525
- Search for workspaces based on last activity (#2658)
2626
```text
@@ -83,6 +83,6 @@ Compare:
8383

8484
##Install/upgrade
8585

86-
Refer to our docs to[install](https://coder.com/docs/v2/latest/install) or
87-
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
86+
Refer to our docs to[install](https://coder.com/docs/install) or
87+
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
8888
release asset below.

‎docs/changelogs/v0.26.0.md

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

33
###Important changes
44

5-
-[Managed variables](https://coder.com/docs/v2/latest/templates/parameters#terraform-template-wide-variables)
5+
-[Managed variables](https://coder.com/docs/templates/parameters#terraform-template-wide-variables)
66
are enabled by default. The following block within templates is obsolete and
77
can be removed from your templates:
88

@@ -16,13 +16,13 @@
1616
>previously necessary to activate this additional feature.
1717
1818
- Our scale test CLI is
19-
[experimental](https://coder.com/docs/v2/latest/contributing/feature-stages#experimental-features)
19+
[experimental](https://coder.com/docs/contributing/feature-stages#experimental-features)
2020
to allow for rapid iteration. You can still interact with it via
2121
`coder exp scaletest` (#8339)
2222

2323
###Features
2424

25-
-[coder dotfiles](https://coder.com/docs/v2/latest/cli/dotfiles) can checkout a
25+
-[coder dotfiles](https://coder.com/docs/cli/dotfiles) can checkout a
2626
specific branch
2727

2828
###Bug fixes
@@ -49,6 +49,6 @@ Compare:
4949

5050
##Install/upgrade
5151

52-
Refer to our docs to[install](https://coder.com/docs/v2/latest/install) or
53-
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
52+
Refer to our docs to[install](https://coder.com/docs/install) or
53+
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
5454
release asset below.

‎docs/changelogs/v0.26.1.md

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

33
###Features
44

5-
-[Devcontainer templates](https://coder.com/docs/v2/latest/templates/dev-containers)
5+
-[Devcontainer templates](https://coder.com/docs/templates/dev-containers)
66
for Coder (#8256)
77
- The dashboard will warn users when a workspace is unhealthy (#8422)
88
- Audit logs`resource_target` search query allows you to search by resource
@@ -31,6 +31,6 @@ Compare:
3131

3232
##Install/upgrade
3333

34-
Refer to our docs to[install](https://coder.com/docs/v2/latest/install) or
35-
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
34+
Refer to our docs to[install](https://coder.com/docs/install) or
35+
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
3636
release asset below.

‎docs/changelogs/v0.27.0.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Agent logs can be pushed after a workspace has started (#8528)
66

77
>⚠️**Warning:** You will need to
8-
>[update](https://coder.com/docs/v2/latest/install) your local Coder CLI v0.27
8+
>[update](https://coder.com/docs/install) your local Coder CLI v0.27
99
>to connect via`coder ssh`.
1010
1111
###Features
@@ -24,7 +24,7 @@ Agent logs can be pushed after a workspace has started (#8528)
2424
- Template version messages (#8435)
2525
<imgwidth="428"alt="252772262-087f1338-f1e2-49fb-81f2-358070a46484"src="https://github.com/coder/coder/assets/22407953/5f6e5e47-e61b-41f1-92fe-f624e92f8bd3">
2626
- TTL and max TTL validation increased to 30 days (#8258)
27-
-[Self-hosted docs](https://coder.com/docs/v2/latest/install/offline#offline-docs):
27+
-[Self-hosted docs](https://coder.com/docs/install/offline#offline-docs):
2828
Host your own copy of Coder's documentation in your own environment (#8527)
2929
(#8601)
3030
- Add custom coder bin path for`config-ssh` (#8425)
@@ -57,7 +57,7 @@ Agent logs can be pushed after a workspace has started (#8528)
5757
Agent logs can be pushed after a workspace has started (#8528)
5858

5959
>⚠️**Warning:** You will need to
60-
>[update](https://coder.com/docs/v2/latest/install) your local Coder CLI v0.27
60+
>[update](https://coder.com/docs/install) your local Coder CLI v0.27
6161
>to connect via`coder ssh`.
6262
6363
###Features
@@ -76,7 +76,7 @@ Agent logs can be pushed after a workspace has started (#8528)
7676
- Template version messages (#8435)
7777
<imgwidth="428"alt="252772262-087f1338-f1e2-49fb-81f2-358070a46484"src="https://github.com/coder/coder/assets/22407953/5f6e5e47-e61b-41f1-92fe-f624e92f8bd3">
7878
- TTL and max TTL validation increased to 30 days (#8258)
79-
-[Self-hosted docs](https://coder.com/docs/v2/latest/install/offline#offline-docs):
79+
-[Self-hosted docs](https://coder.com/docs/install/offline#offline-docs):
8080
Host your own copy of Coder's documentation in your own environment (#8527)
8181
(#8601)
8282
- Add custom coder bin path for`config-ssh` (#8425)
@@ -115,8 +115,8 @@ Compare:
115115

116116
##Install/upgrade
117117

118-
Refer to our docs to[install](https://coder.com/docs/v2/latest/install) or
119-
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
118+
Refer to our docs to[install](https://coder.com/docs/install) or
119+
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
120120
release asset below.
121121

122122
- Custom API use cases (custom agent logs, CI/CD pipelines) (#8445)
@@ -132,6 +132,6 @@ Compare:
132132

133133
##Install/upgrade
134134

135-
Refer to our docs to[install](https://coder.com/docs/v2/latest/install) or
136-
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
135+
Refer to our docs to[install](https://coder.com/docs/install) or
136+
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
137137
release asset below.

‎docs/changelogs/v0.27.1.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,6 @@ Compare:
2121

2222
##Install/upgrade
2323

24-
Refer to our docs to[install](https://coder.com/docs/v2/latest/install) or
25-
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
24+
Refer to our docs to[install](https://coder.com/docs/install) or
25+
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
2626
release asset below.

‎docs/changelogs/v0.27.3.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ Compare:
1515

1616
##Install/upgrade
1717

18-
Refer to our docs to[install](https://coder.com/docs/v2/latest/install) or
19-
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
18+
Refer to our docs to[install](https://coder.com/docs/install) or
19+
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
2020
release asset below.

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp