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

Skip to content

Commit d5bbd16

Browse files
EdwardAngertEdwardAngert
committed
fix broken links
1 parent 234f978 commit d5bbd16

File tree

21 files changed

+40
-41
lines changed

21 files changed

+40
-41
lines changed

‎docs/admin/monitoring/health-check.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ misconfigured reverse HTTP proxy. Additionally, while workspace users should
148148
still be able to reach their workspaces, connection performance may be degraded.
149149

150150
> **Note:** This may also be shown if you have
151-
> [forced websocket connections for DERP](../cli/server.md#--derp-force-websockets).
151+
> [forced websocket connections for DERP](../../reference/cli/server.md#--derp-force-websockets).
152152
153153
**Solution:** ensure that any proxies you use allow connection upgrade with the
154154
`Upgrade: derp` header.

‎docs/admin/networking/port-forwarding.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ For more examples, see `coder port-forward --help`.
4949
## Dashboard
5050

5151
> To enable port forwarding via the dashboard, Coder must be configured with a
52-
> [wildcard access URL](../admin/configure.md#wildcard-access-url). If an access
52+
> [wildcard access URL](../../admin/setup.md#wildcard-access-url). If an access
5353
> URL is not specified, Coder will create
54-
> [a publicly accessible URL](../admin/configure.md#tunnel) to reverse proxy the
54+
> [a publicly accessible URL](../../admin/setup.md#tunnel) to reverse proxy the
5555
> deployment, and port forwarding will work.
5656
>
5757
> There is a
@@ -274,7 +274,7 @@ configurable by either admins or users.
274274
275275
## SSH
276276

277-
First, [configure SSH](../ides.md#ssh-configuration) on your local machine.
277+
First, [configure SSH](../../user-guides/workspace-access/README.md#configure-ssh) on your local machine.
278278
Then, use `ssh` to forward like so:
279279

280280
```console

‎docs/admin/provisioners.md

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

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

@@ -34,14 +34,14 @@ Provisioners are started with the
3434
The provisioner daemon must authenticate with your Coder deployment.
3535

3636
Set a
37-
[provisioner daemon pre-shared key (PSK)](../cli/server.md#--provisioner-daemon-psk)
37+
[provisioner daemon pre-shared key (PSK)](../reference/cli/server.md#--provisioner-daemon-psk)
3838
on the Coder server and start the provisioner with
3939
`coder provisionerd start --psk <your-psk>`. If you are
4040
[installing with Helm](../install/kubernetes.md#install-coder-with-helm), see
4141
the [Helm example](#example-running-an-external-provisioner-with-helm) below.
4242

4343
> Coder still supports authenticating the provisioner daemon with a
44-
> [token](../cli.md#--token) from a user with the Template Admin or Owner role.
44+
> [token](../reference/cli/tokens.md) from a user with the Template Admin or Owner role.
4545
> This method is deprecated in favor of the PSK, which only has permission to
4646
> access provisioner daemon APIs. We recommend migrating to the PSK as soon as
4747
> practical.
@@ -52,12 +52,12 @@ Provisioners can broadly be categorized by scope: `organization` or `user`. The
5252
scope of a provisioner can be specified with
5353
[`-tag=scope=<scope>`](../reference/cli/provisioner_start.md#t---tag) when
5454
starting the provisioner daemon. Only users with at least the
55-
[Template Admin](../admin/users.md#roles) role or higher may create
55+
[Template Admin](../admin/users/groups-roles.md#roles) role or higher may create
5656
organization-scoped provisioner daemons.
5757

5858
There are two exceptions:
5959

60-
- [Built-in provisioners](../cli/server.md#provisioner-daemons) are always
60+
- [Built-in provisioners](../reference/cli/server.md#provisioner-daemons) are always
6161
organization-scoped.
6262
- External provisioners started using a
6363
[pre-shared key (PSK)](../reference/cli/provisioner_start.md#psk) are always
@@ -264,7 +264,7 @@ docker run --rm -it \
264264

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

269269
```shell
270270
coder server --provisioner-daemons=0

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ other services.
66

77
## Who creates templates?
88

9-
The [Template Admin](../admin/users.md) role (and above) can create templates.
9+
The [Template Admin](../../../admin/users/groups-roles.md#roles) role (and above) can create templates.
1010
End users, like developers, create workspaces from them. Templates can also be
1111
[managed with git](./change-management.md), allowing any developer to propose
1212
changes to a template.
@@ -41,13 +41,13 @@ by our users
4141
Our starter templates are meant to be modified for your use cases. You can edit
4242
any template's files directly in the Coder dashboard.
4343

44-
![Editing a template](../../images/templates/choosing-edit-template.gif)
44+
![Editing a template](../../../images/templates/choosing-edit-template.gif)
4545

4646
If you'd prefer to use the CLI, use `coder templates pull`, edit the template
4747
files, then `coder templates push`.
4848

4949
> Even if you are a Terraform expert, we suggest reading our
50-
> [guided tour](./tour.md).
50+
> [guided tour of a template](../../../tutorials/template-from-scratch.md).
5151
5252
## Updating templates
5353

@@ -56,7 +56,7 @@ When you publish a new version, developers are notified to get the latest
5656
infrastructure, software, or security patches. Learn more about
5757
[change management](./change-management.md).
5858

59-
![Updating a template](../../images/templates/update.png)
59+
![Updating a template](../../../images/templates/update.png)
6060

6161
### Template update policies (enterprise)
6262

@@ -67,18 +67,18 @@ forced to update their workspaces before starting them once the setting is
6767
applied. Workspaces which leverage autostart or start-on-connect will be
6868
automatically updated on the next startup.
6969

70-
![Template update policies](../../images/templates/update-policies.png)
70+
![Template update policies](../../../images/templates/update-policies.png)
7171

7272
## Delete templates
7373

7474
You can delete a template using both the coder CLI and UI. Only
75-
[template admins and owners](../admin/users.md) can delete a template, and the
75+
[template admins and owners](../../users/groups-roles.md#roles) can delete a template, and the
7676
template must not have any running workspaces associated to it.
7777

7878
In the UI, navigate to the template you want to delete, and select the dropdown
7979
in the right-hand corner of the page to delete the template.
8080

81-
![delete-template](../../images/delete-template.png)
81+
![delete-template](../../../images/delete-template.png)
8282

8383
Using the CLI, login to Coder and run the following command to delete a
8484
template:
@@ -92,5 +92,5 @@ coder templates delete <template-name>
9292
## Next steps
9393

9494
- [Image management](./image-management.md)
95-
- [Devcontainer templates](./devcontainer-templates.md)
95+
- [Devcontainer templates](./devcontainers.md)
9696
- [Change management](./change-management.md)

‎docs/admin/users/oidc-auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ CODER_DISABLE_PASSWORD_AUTH=true
134134

135135
Coder supports user provisioning and deprovisioning via SCIM 2.0 with header
136136
authentication. Upon deactivation, users are
137-
[suspended](./users.md#suspend-a-user) and are not deleted.
137+
[suspended](../users/README.md#suspend-a-user) and are not deleted.
138138
[Configure](./configure.md) your SCIM application with an auth key and supply it
139139
the Coder server.
140140

‎docs/tutorials/template-from-scratch.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ This guided tour introduces you to the different parts of a Coder template by
44
showing you how to create a template from scratch.
55

66
You'll write a simple template that provisions a workspace as a Docker container
7-
with Ubuntu. This simple template is based on the same Docker starter template
8-
that the [tutorial](./tutorial.md) uses.
7+
with Ubuntu.
98

109
## Before you start
1110

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ keytool -import -alias coder -file cacert.pem -keystore /Applications/JetBrains\
139139
140140
1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html).
141141

142-
1. [Configure the `coder` CLI](../ides.md#ssh-configuration).
142+
1. [Configure the `coder` CLI](../../user-guides/workspace-access/README.md#configure-ssh).
143143

144144
1. Open Gateway, make sure **SSH** is selected under **Remote Development**.
145145

@@ -354,7 +354,7 @@ Additionally, create a string for each setting with its appropriate value in
354354

355355
With the server now configured, you can now configure your local machine to use
356356
Gateway. Here is the documentation to
357-
[setup SSH config via the Coder CLI](../ides.md#ssh-configuration). On the
357+
[setup SSH config via the Coder CLI](../../user-guides/workspace-access/README.md#configure-ssh). On the
358358
Gateway side, follow our guide here until step 16.
359359

360360
Instead of downloading from jetbrains.com, we will point Gateway to our server

‎docs/user-guides/workspace-access/port-forwarding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ configurable by either admins or users.
262262

263263
## SSH
264264

265-
First, [configure SSH](../ides.md#ssh-configuration) on your local machine.
265+
First, [configure SSH](../../user-guides/workspace-access/README.md#configure-ssh) on your local machine.
266266
Then, use `ssh` to forward like so:
267267

268268
```console

‎site/src/modules/resources/SSHButton/SSHButton.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,13 +75,13 @@ export const SSHButton: FC<SSHButtonProps> = ({
7575
<HelpTooltipLink href={docs("/install")}>
7676
Install Coder CLI
7777
</HelpTooltipLink>
78-
<HelpTooltipLink href={docs("/ides#vs-code-remote")}>
78+
<HelpTooltipLink href={docs("/user-guides/workspace-access/vscode")}>
7979
Connect via VS Code Remote SSH
8080
</HelpTooltipLink>
81-
<HelpTooltipLink href={docs("/ides#jetbrains-gateway")}>
81+
<HelpTooltipLink href={docs("/user-guides/workspace-access/jetbrains#jetbrains-gateway")}>
8282
Connect via JetBrains Gateway
8383
</HelpTooltipLink>
84-
<HelpTooltipLink href={docs("/ides#ssh-configuration")}>
84+
<HelpTooltipLink href={docs("/user-guides/workspace-access#configure-ssh")}>
8585
SSH configuration
8686
</HelpTooltipLink>
8787
</HelpTooltipLinksGroup>

‎site/src/pages/AuditPage/AuditFilter.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ export const AuditFilter: FC<AuditFilterProps> = ({ filter, error, menus }) => {
5151

5252
return (
5353
<Filter
54-
learnMoreLink={docs("/admin/audit-logs#filtering-logs")}
54+
learnMoreLink={docs("/admin/security/audit-logs#filtering-logs")}
5555
presets={PRESET_FILTERS}
5656
isLoading={menus.user.isInitializing}
5757
filter={filter}

‎site/src/pages/AuditPage/AuditHelpTooltip.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export const AuditHelpTooltip: FC = () => {
2525
<HelpTooltipTitle>{Language.title}</HelpTooltipTitle>
2626
<HelpTooltipText>{Language.body}</HelpTooltipText>
2727
<HelpTooltipLinksGroup>
28-
<HelpTooltipLink href={docs("/admin/audit-logs")}>
28+
<HelpTooltipLink href={docs("/admin/security/audit-logs")}>
2929
{Language.docs}
3030
</HelpTooltipLink>
3131
</HelpTooltipLinksGroup>

‎site/src/pages/AuditPage/AuditPageView.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ export const AuditPageView: FC<AuditPageViewProps> = ({
139139
<Paywall
140140
message="Audit logs"
141141
description="Audit logs allow you to monitor user operations on your deployment. You need an Premium license to use this feature."
142-
documentationLink={docs("/admin/audit-logs")}
142+
documentationLink={docs("/admin/security/audit-logs")}
143143
/>
144144
</Cond>
145145
</ChooseOne>

‎site/src/pages/DeploySettingsPage/GeneralSettingsPage/GeneralSettingsPageView.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ export const GeneralSettingsPageView: FC<GeneralSettingsPageViewProps> = ({
7575
It is recommended that you remove these experiments from your
7676
configuration as they have no effect. See{" "}
7777
<a
78-
href="https://coder.com/docs/cli/server#--experiments"
78+
href="https://coder.com/docs/reference/cli/server#--experiments"
7979
target="_blank"
8080
rel="noreferrer"
8181
>

‎site/src/pages/DeploySettingsPage/ObservabilitySettingsPage/ObservabilitySettingsPageView.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export const ObservabilitySettingsPageView: FC<
3535
title="Audit Logging"
3636
secondary
3737
description="Allow auditors to monitor user operations in your deployment."
38-
docsHref={docs("/admin/audit-logs")}
38+
docsHref={docs("/admin/security/audit-logs")}
3939
/>
4040

4141
<Badges>

‎site/src/pages/DeploySettingsPage/UserAuthSettingsPage/UserAuthSettingsPageView.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export const UserAuthSettingsPageView = ({
3333
title="Login with OpenID Connect"
3434
secondary
3535
description="Set up authentication to login with OpenID Connect."
36-
docsHref={docs("/admin/auth#openid-connect-with-google")}
36+
docsHref={docs("/admin/users/oidc-auth")}
3737
/>
3838

3939
<Badges>{oidcEnabled ? <EnabledBadge /> : <DisabledBadge />}</Badges>
@@ -52,7 +52,7 @@ export const UserAuthSettingsPageView = ({
5252
title="Login with GitHub"
5353
secondary
5454
description="Set up authentication to login with GitHub."
55-
docsHref={docs("/admin/auth#github")}
55+
docsHref={docs("/admin/external-auth#github")}
5656
/>
5757

5858
<Badges>

‎site/src/pages/GroupsPage/GroupsPageView.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ export const GroupsPageView: FC<GroupsPageViewProps> = ({
4848
<Paywall
4949
message="Groups"
5050
description="Organize users into groups with restricted access to templates. You need an Premium license to use this feature."
51-
documentationLink={docs("/admin/groups")}
51+
documentationLink={docs("/admin/users/groups")}
5252
/>
5353
</Cond>
5454
<Cond>

‎site/src/pages/ManagementSettingsPage/CustomRolesPage/CustomRolesPageView.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ export const CustomRolesPageView: FC<CustomRolesPageViewProps> = ({
5252
<Paywall
5353
message="Custom Roles"
5454
description="Create custom roles to grant users a tailored set of granular permissions."
55-
documentationLink={docs("/admin/groups")}
55+
documentationLink={docs("/admin/users/groups")}
5656
/>
5757
)}
5858
<Stack

‎site/src/pages/ManagementSettingsPage/GroupsPage/GroupsPageView.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ export const GroupsPageView: FC<GroupsPageViewProps> = ({
4848
<Paywall
4949
message="Groups"
5050
description="Organize users into groups with restricted access to templates. You need a Premium license to use this feature."
51-
documentationLink={docs("/admin/groups")}
51+
documentationLink={docs("/admin/users/groups")}
5252
/>
5353
</Cond>
5454
<Cond>

‎site/src/pages/ManagementSettingsPage/IdpSyncPage/IdpSyncHelpTooltip.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export const IdpSyncHelpTooltip: FC = () => {
2121
Coder. Use the Coder CLI to configure these mappings.
2222
</HelpTooltipText>
2323
<HelpTooltipLinksGroup>
24-
<HelpTooltipLink href={docs("/admin/auth#group-sync-enterprise")}>
24+
<HelpTooltipLink href={docs("/admin/users/oidc-auth.md#group-sync-enterprise")}>
2525
Configure IdP Sync
2626
</HelpTooltipLink>
2727
</HelpTooltipLinksGroup>

‎site/src/pages/ManagementSettingsPage/IdpSyncPage/IdpSyncPage.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ export const IdpSyncPage: FC = () => {
7474
<Button
7575
startIcon={<LaunchOutlined />}
7676
component="a"
77-
href={docs("/admin/auth#group-sync-enterprise")}
77+
href={docs("/admin/users/oidc-auth.md#group-sync-enterprise")}
7878
target="_blank"
7979
>
8080
Setup IdP Sync
@@ -85,7 +85,7 @@ export const IdpSyncPage: FC = () => {
8585
<Paywall
8686
message="IdP Sync"
8787
description="Configure group and role mappings to manage permissions outside of Coder. You need an Premium license to use this feature."
88-
documentationLink={docs("/admin/groups")}
88+
documentationLink={docs("/admin/users/groups")}
8989
/>
9090
</Cond>
9191
<Cond>

‎site/src/pages/UserSettingsPage/SecurityPage/SingleSignOnSection.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ const SSOEmptyState: FC = () => {
111111
message="No SSO Providers"
112112
description="No SSO providers are configured with this Coder deployment."
113113
cta={
114-
<Link href={docs("/admin/auth")} target="_blank" rel="noreferrer">
114+
<Link href={docs("/admin/external-auth")} target="_blank" rel="noreferrer">
115115
Learn how to add a provider
116116
</Link>
117117
}

0 commit comments

Comments
 (0)