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

Commitfa69d1c

Browse files
ci: reenable link checker & fix broken links (#15489)
Follow-up on#15484.
1 parentd6442db commitfa69d1c

File tree

16 files changed

+47
-32
lines changed

16 files changed

+47
-32
lines changed

‎.github/.linkspector.yml

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,22 @@
11
dirs:
22
-docs
3+
excludedDirs:
4+
# Downstream bug in linkspector means large markdown files fail to parse
5+
# but these are autogenerated and shouldn't need checking
6+
-docs/reference
7+
# Older changelogs may contain broken links
8+
-docs/changelogs
39
ignorePatterns:
4-
-pattern:"://localhost"
5-
-pattern:'://.*.?example\\.com'
6-
-pattern:"github.com/<your_github_handle>"
10+
-pattern:"localhost"
11+
-pattern:"example.com"
712
-pattern:"mailto:"
13+
-pattern:"127.0.0.1"
14+
-pattern:"0.0.0.0"
15+
-pattern:"JFROG_URL"
16+
-pattern:"coder.company.org"
17+
# These real sites were blocking the linkspector action / GitHub runner IPs(?)
18+
-pattern:"i.imgur.com"
19+
-pattern:"code.visualstudio.com"
20+
-pattern:"www.emacswiki.org"
821
aliveStatusCodes:
922
-200

‎.github/workflows/weekly-docs.yaml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ on:
44
schedule:
55
-cron:"0 9 * * 1"
66
workflow_dispatch:# allows to run manually for testing
7-
#pull_request:
8-
# branches:
9-
# - main
10-
# paths:
11-
# - "docs/**"
7+
pull_request:
8+
branches:
9+
-main
10+
paths:
11+
-"docs/**"
1212

1313
permissions:
1414
contents:read
@@ -33,6 +33,7 @@ jobs:
3333
reporter:github-pr-review
3434
config_file:".github/.linkspector.yml"
3535
fail_on_error:"true"
36+
filter_mode:"nofilter"
3637

3738
-name:Send Slack notification
3839
if:failure() && github.event_name == 'schedule'

‎docs/admin/infrastructure/scale-testing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ capabilities, allowing Coder to efficiently deploy, scale, and manage workspaces
1111
across a distributed infrastructure. This ensures high availability, fault
1212
tolerance, and scalability for Coder deployments. Coder is deployed on this
1313
cluster using the
14-
[Helm chart](../../install/kubernetes.md#install-coder-with-helm).
14+
[Helm chart](../../install/kubernetes.md#4-install-coder-with-helm).
1515

1616
##Methodology
1717

@@ -113,7 +113,7 @@ on the workload size to ensure deployment stability.
113113
####CPU and memory usage
114114

115115
Enabling
116-
[agent stats collection](../../reference/cli/index.md#--prometheus-collect-agent-stats)
116+
[agent stats collection](../../reference/cli/server.md#--prometheus-collect-agent-stats)
117117
(optional) may increase memory consumption.
118118

119119
Enabling direct connections between users and workspace agents (apps or SSH

‎docs/admin/integrations/kubernetes-logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ or deployment, such as:
1414
[`kubernetes_deployment`](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/deployment)
1515
Terraform resource, which requires the`coder` service account to have
1616
permission to create deployments. For example, if you use
17-
[Helm](../../install/kubernetes.md#install-coder-with-helm) to install Coder,
17+
[Helm](../../install/kubernetes.md#4-install-coder-with-helm) to install Coder,
1818
you should set`coder.serviceAccount.enableDeployments=true` in your
1919
`values.yaml`
2020

‎docs/admin/networking/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ In order for clients to be able to establish direct connections:
5656
communicate with each other using their locally assigned IP addresses, then a
5757
direct connection can be established immediately. Otherwise, the client and
5858
agent will contact
59-
[the configured STUN servers](../../reference/cli/server.md#derp-server-stun-addresses)
59+
[the configured STUN servers](../../reference/cli/server.md#--derp-server-stun-addresses)
6060
to try and determine which`ip:port` can be used to communicate with their
6161
counterpart. See[STUN and NAT](./stun.md) for more details on how this
6262
process works.

‎docs/admin/networking/workspace-proxies.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ Workspace proxies provide low-latency experiences for geo-distributed teams.
44

55
Coder's networking does a best effort to make direct connections to a workspace.
66
In situations where this is not possible, such as connections via the web
7-
terminal and[web IDEs](../../user-guides/workspace-access/index.md#web-ides),
7+
terminal and
8+
[web IDEs](../../user-guides/workspace-access/index.md#other-web-ides),
89
workspace proxies are able to reduce the amount of distance the network traffic
910
needs to travel.
1011

‎docs/admin/provisioners.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#External provisioners
22

33
By default, the Coder server runs
4-
[built-in provisioner daemons](../reference/cli/server.md#provisioner-daemons),
4+
[built-in provisioner daemons](../reference/cli/server.md#--provisioner-daemons),
55
which execute`terraform` during workspace and template builds. However, there
66
are often benefits to running external provisioner daemons:
77

@@ -235,17 +235,17 @@ This is illustrated in the below table:
235235

236236
Provisioners can broadly be categorized by scope:`organization` or`user`. The
237237
scope of a provisioner can be specified with
238-
[`-tag=scope=<scope>`](../reference/cli/provisioner_start.md#t---tag) when
238+
[`-tag=scope=<scope>`](../reference/cli/provisioner_start.md#-t---tag) when
239239
starting the provisioner daemon. Only users with at least the
240240
[Template Admin](./users/index.md#roles) role or higher may create
241241
organization-scoped provisioner daemons.
242242

243243
There are two exceptions:
244244

245-
- [Built-in provisioners](../reference/cli/server.md#provisioner-daemons) are
245+
- [Built-in provisioners](../reference/cli/server.md#--provisioner-daemons) are
246246
always organization-scoped.
247247
- External provisioners started using a
248-
[pre-shared key (PSK)](../reference/cli/provisioner_start.md#psk) are always
248+
[pre-shared key (PSK)](../reference/cli/provisioner_start.md#--psk) are always
249249
organization-scoped.
250250

251251
### Organization-Scoped Provisioners
@@ -369,7 +369,7 @@ docker run --rm -it \
369369

370370
As mentioned above, the Coder server will run built-in provisioners by default.
371371
This can be disabled with a server-wide
372-
[flag or environment variable](../reference/cli/server.md#provisioner-daemons).
372+
[flag or environment variable](../reference/cli/server.md#--provisioner-daemons).
373373

374374
```sh
375375
coder server --provisioner-daemons=0

‎docs/admin/security/database-encryption.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ preventing attackers with database access from using them to impersonate users.
77
##How it works
88

99
Coder allows administrators to specify
10-
[external token encryption keys](../../reference/cli/server.md#external-token-encryption-keys).
10+
[external token encryption keys](../../reference/cli/server.md#--external-token-encryption-keys).
1111
If configured, Coder will use these keys to encrypt external user tokens before
1212
storing them in the database. The encryption algorithm used is AES-256-GCM with
1313
a 32-byte key length.

‎docs/admin/templates/creating-templates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ You will then see your new template in the dashboard.
145145
##From scratch (advanced)
146146

147147
There may be cases where you want to create a template from scratch. You can use
148-
[any Terraform provider](https://registry.terraform.com) with Coder to create
148+
[any Terraform provider](https://registry.terraform.io) with Coder to create
149149
templates for additional clouds (e.g. Hetzner, Alibaba) or orchestrators
150150
(VMware, Proxmox) that we do not provide example templates for.
151151

‎docs/admin/templates/managing-templates/schedule.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ to set the default quiet hours to a time when most users are not expected to be
9797
using Coder.
9898

9999
Admins can force users to use the default quiet hours with the
100-
[CODER_ALLOW_CUSTOM_QUIET_HOURS](../../../reference/cli/server.md#allow-custom-quiet-hours)
100+
[CODER_ALLOW_CUSTOM_QUIET_HOURS](../../../reference/cli/server.md#--allow-custom-quiet-hours)
101101
environment variable. Users will still be able to see the page, but will be
102102
unable to set a custom time or timezone. If users have already set a custom
103103
quiet hours schedule, it will be ignored and the default will be used instead.

‎docs/admin/users/idp-sync.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -326,9 +326,8 @@ the OIDC provider. See
326326
> Depending on the OIDC provider, this claim may be named differently. Common
327327
> ones include `groups`, `memberOf`, and `roles`.
328328

329-
Next configure the Coder server to read groups from the claim name with the
330-
[OIDC organization field](../../reference/cli/server.md#--oidc-organization-field)
331-
server flag:
329+
Next configure the Coder server to read groups from the claim name with the OIDC
330+
organization field server flag:
332331

333332
```sh
334333
# as an environment variable

‎docs/install/offline.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ provider_installation {
137137

138138
##Run offline via Docker
139139

140-
Follow our[docker-compose](./docker.md#run-coder-with-docker-compose)
140+
Follow our[docker-compose](./docker.md#install-coder-via-docker-compose)
141141
documentation and modify the docker-compose file to specify your custom Coder
142142
image. Additionally, you can add a volume mount to add providers to the
143143
filesystem mirror without re-building the image.

‎docs/reference/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ activity.
8282
}"
8383
```
8484

85-
-[Manually send workspace activity](../reference/api/agents.md#submit-workspace-agent-stats):
85+
-[Manually send workspace activity](../reference/api/workspaces.md#extend-workspace-deadline-by-id):
8686
Keep a workspace "active," even if there is not an open connection (e.g. for a
8787
long-running machine learning job).
8888

@@ -94,10 +94,10 @@ activity.
9494
do
9595
if pgrep -f"my_training_script.py"> /dev/null
9696
then
97-
curl -X POST"https://coder.example.com/api/v2/workspaceagents/me/report-stats" \
97+
curl -X POST"https://coder.example.com/api/v2/workspaces/$WORKSPACE_ID/extend" \
9898
-H"Coder-Session-Token:$CODER_AGENT_TOKEN" \
9999
-d'{
100-
"connection_count":1
100+
"deadline":"2019-08-24T14:15:22Z"
101101
}'
102102

103103
# Sleep for 30 minutes (1800 seconds) if the job is running

‎docs/user-guides/workspace-access/vscode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ extension, authenticates with Coder, and connects to the workspace.
1616
![Demo](https://github.com/coder/vscode-coder/raw/main/demo.gif?raw=true)
1717

1818
>The`VS Code Desktop` button can be hidden by enabling
19-
>[Browser-only connections](../../admin/networking/index.md#browser-only-connections-enterprise).
19+
>[Browser-only connections](../../admin/networking/index.md#browser-only-connections-enterprise-premium).
2020
2121
###Manual Installation
2222

‎docs/user-guides/workspace-access/web-ides.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,6 @@ guide.
7676
##SSH Fallback
7777

7878
If you prefer to run web IDEs in localhost, you can port forward using
79-
[SSH](../index.md#ssh) or the Coder CLI`port-forward` sub-command. Some web
80-
IDEsmay not support URL base path adjustment so port forwarding is the only
79+
[SSH](./index.md#ssh) or the Coder CLI`port-forward` sub-command. Some web IDEs
80+
may not support URL base path adjustment so port forwarding is the only
8181
approach.

‎docs/user-guides/workspace-management.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,8 @@ To set a workspace's schedule, go to the workspace, then **Settings** >
112112
![Scheduling UI](../images/schedule.png)
113113

114114
Coder might also stop a workspace automatically if there is a
115-
[template update](../admin/templates/index.md#Start/stop) available.
115+
[template update](../admin/templates/managing-templates/index.md#updating-templates)
116+
available.
116117

117118
Learn more about[workspace lifecycle](./workspace-lifecycle.md) and our
118119
[scheduling features](./workspace-scheduling.md).

0 commit comments

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