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

Skip to content

Commit 4c072e0

Browse files
committed
Update internal documentation links
Correct and update various internal links across documentation files to ensure consistent navigation throughout the documentation set. This enhances usability and reduces the potential for broken links.
1 parent 3968e47 commit 4c072e0

File tree

13 files changed

+36
-35
lines changed

13 files changed

+36
-35
lines changed

docs/admin/infrastructure/validated-architectures/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,12 @@ web interface, the CLI tool, or directly calling API methods.
6868

6969
### Workspace
7070

71-
A [workspace](../../../user-guides/workspace-creation.md) refers to an isolated
72-
development environment where users can write, build, and run code. Workspaces
73-
are fully configurable and can be tailored to specific project requirements,
74-
providing developers with a consistent and efficient development environment.
75-
Workspaces can be autostarted and autostopped, enabling efficient resource
76-
management.
71+
A [workspace](../../../user-guides/workspace-management.md) refers to an
72+
isolated development environment where users can write, build, and run code.
73+
Workspaces are fully configurable and can be tailored to specific project
74+
requirements, providing developers with a consistent and efficient development
75+
environment. Workspaces can be autostarted and autostopped, enabling efficient
76+
resource management.
7777

7878
Users can connect to workspaces using SSH or via workspace applications like
7979
`code-server`, facilitating collaboration and remote access. Additionally,

docs/admin/monitoring/health-check.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ number of details about the health of your Coder deployment.
66
![Health check in Coder Dashboard](../../images/admin/monitoring/health-check.png)
77

88
You can view it at `https://${CODER_URL}/health`, or you can alternatively view
9-
the [JSON response directly](../api/debug.md#debug-info-deployment-health).
9+
the
10+
[JSON response directly](../../reference/api/debug.md#debug-info-deployment-health).
1011

1112
The deployment health page is broken up into the following sections:
1213

docs/admin/monitoring/logs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ Connect logs are all captured in the `coderd` logs.
2525
## `provisionerd` Logs
2626

2727
Logs for [external provisioners](../provisioners.md) are structured
28-
[and configured](../../reference/cli/provisionerd_start.md#--log-human)
29-
similarly to `coderd` logs. Use these logs to troubleshoot and monitor the
30-
Terraform operations behind workspaces and templates.
28+
[and configured](../../reference/cli/provisioner_start.md#--log-human) similarly
29+
to `coderd` logs. Use these logs to troubleshoot and monitor the Terraform
30+
operations behind workspaces and templates.
3131

3232
## Workspace Logs
3333

docs/admin/monitoring/notifications/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ flags.
7373

7474
Notifications can currently be delivered by either SMTP or webhook. Each message
7575
can only be delivered to one method, and this method is configured globally with
76-
[`CODER_NOTIFICATIONS_METHOD`](../../../reference/cli/server#--notifications-method)
76+
[`CODER_NOTIFICATIONS_METHOD`](../../../reference/cli/server.md#--notifications-method)
7777
(default: `smtp`).
7878

7979
Enterprise customers can configure which method to use for each of the supported

docs/admin/templates/creating-templates.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,8 @@ templates for additional clouds (e.g. Hetzner, Alibaba) or orchestrators
152152
Refer to the following resources:
153153

154154
- [Tutorial: Create a template from scratch](../../tutorials/template-from-scratch.md)
155-
- [Extending templates](./editing-templates.md): Features and concepts around
156-
templates (agents, parameters, variables, etc)
155+
- [Extending templates](./extending-templates/index.md): Features and concepts
156+
around templates (agents, parameters, variables, etc)
157157
- [Coder Registry](https://registry.coder.com/templates): Official and community
158158
templates for Coder
159159
- [Coder Terraform Provider Reference](https://registry.terraform.io/providers/coder/coder)

docs/admin/templates/managing-templates/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ them. Templates can also be [managed with git](./change-management.md), allowing
1212
any developer to propose changes to a template.
1313

1414
You can give different users and groups access to templates with
15-
[role-based access control](../admin/rbac.md).
15+
[role-based access control](../template-permissions.md).
1616

1717
## Starter templates
1818

docs/admin/users/oidc-auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ CODER_OIDC_ICON_URL=https://gitea.io/images/gitea.png
119119
```
120120

121121
To change the icon and text above the OpenID Connect button, see application
122-
name and logo url in [appearance](./appearance.md) settings.
122+
name and logo url in [appearance](../setup/appearance.md) settings.
123123

124124
## Disable Built-in Authentication
125125

docs/admin/users/organizations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Successfully created provisioner key data-cluster! Save this authentication toke
7474
Next, start the provisioner with the key on your desired platform. In this
7575
example, we'll start it using the Coder CLI on a host with Docker. For
7676
instructions on using other platforms like Kubernetes, see our
77-
[provisioner documentation](../admin/provisioners.md).
77+
[provisioner documentation](../provisioners.md).
7878

7979
```sh
8080
export CODER_URL=https://<your-coder-url>

docs/admin/users/quotas.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ For example: A template is configured with a cost of 5 credits per day, and the
99
user is granted 15 credits, which can be consumed by both started and stopped
1010
workspaces. This budget limits the user to 3 concurrent workspaces.
1111

12-
Quotas are scoped to [Groups](./groups.md) in Enterprise and
12+
Quotas are scoped to [Groups](./groups-roles.md) in Enterprise and
1313
[organizations](./organizations.md) in Premium.
1414

1515
## Definitions

docs/admin/users/sessions-tokens.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ Use the following command:
4444
coder tokens create --name=my-token --lifetime=720h
4545
```
4646

47-
See the help docs for [`coder tokens create`](../../reference/cli/tokens_create)
48-
for more info.
47+
See the help docs for
48+
[`coder tokens create`](../../reference/cli/tokens_create.md) for more info.
4949

5050
</div>
5151

docs/install/other/index.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
Coder has a number of alternate unofficial install methods. Contributions are
44
welcome!
55

6-
| Platform Name | Status | Documentation |
7-
| --------------------------------------------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------- |
8-
| AWS EC2 | Official | [Guide: AWS](../cloud/ec2.md) |
9-
| Google Compute Engine | Official | [Guide: Google Compute Engine](../cloud/compute-engine.md) |
10-
| Azure AKS | Unofficial | [GitHub: coder-aks](https://github.com/ericpaulsen/coder-aks) |
11-
| Terraform (GKE, AKS, LKE, DOKS, IBMCloud K8s, OVHCloud K8s, Scaleway K8s Kapsule) | Unofficial | [GitHub: coder-oss-terraform](https://github.com/ElliotG/coder-oss-tf) |
12-
| Fly.io | Unofficial | [Blog: Run Coder on Fly.io](https://coder.com/blog/remote-developer-environments-on-fly-io) |
13-
| Garden.io | Unofficial | [GitHub: garden-coder-example](https://github.com/garden-io/garden-coder-example) |
14-
| Railway.app | Unofficial | [Blog: Run Coder on Railway.app](https://coder.com/blog/deploy-coder-on-railway-app) |
15-
| Heroku | Unofficial | [Docs: Deploy Coder on Heroku](https://github.com/coder/packages/blob/main/heroku/index.md) |
16-
| Render | Unofficial | [Docs: Deploy Coder on Render](https://github.com/coder/packages/blob/main/render/index.md) |
17-
| Snapcraft | Unofficial | [Get it from the Snap Store](https://snapcraft.io/coder) |
6+
| Platform Name | Status | Documentation |
7+
| --------------------------------------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------- |
8+
| AWS EC2 | Official | [Guide: AWS](../cloud/ec2.md) |
9+
| Google Compute Engine | Official | [Guide: Google Compute Engine](../cloud/compute-engine.md) |
10+
| Azure AKS | Unofficial | [GitHub: coder-aks](https://github.com/ericpaulsen/coder-aks) |
11+
| Terraform (GKE, AKS, LKE, DOKS, IBMCloud K8s, OVHCloud K8s, Scaleway K8s Kapsule) | Unofficial | [GitHub: coder-oss-terraform](https://github.com/ElliotG/coder-oss-tf) |
12+
| Fly.io | Unofficial | [Blog: Run Coder on Fly.io](https://coder.com/blog/remote-developer-environments-on-fly-io) |
13+
| Garden.io | Unofficial | [GitHub: garden-coder-example](https://github.com/garden-io/garden-coder-example) |
14+
| Railway.app | Unofficial | [Blog: Run Coder on Railway.app](https://coder.com/blog/deploy-coder-on-railway-app) |
15+
| Heroku | Unofficial | [Docs: Deploy Coder on Heroku](https://github.com/coder/packages/blob/main/heroku/README.md) |
16+
| Render | Unofficial | [Docs: Deploy Coder on Render](https://github.com/coder/packages/blob/main/render/README.md) |
17+
| Snapcraft | Unofficial | [Get it from the Snap Store](https://snapcraft.io/coder) |

docs/start/first-workspace.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ each work from their own workspace and can use
55
[multiple IDEs](../user-guides/workspace-access/index.md).
66

77
A developer creates a workspace from a
8-
[shared template](../tutorials/templates/index.md). This lets an entire team
9-
work in environments that are identically configured and provisioned with the
10-
same resources.
8+
[shared template](../admin/templates/index.md). This lets an entire team work in
9+
environments that are identically configured and provisioned with the same
10+
resources.
1111

1212
## Before you begin
1313

docs/user-guides/workspace-scheduling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ configured by your template admin, which will stop a workspace when a user's
99
absence is detected.
1010

1111
To learn more workspace states and schedule, read the
12-
[workspace lifecycle](../admin/workspaces/lifecycle.md) documentation.
12+
[workspace lifecycle](../user-guides/workspace-lifecycle.md) documentation.
1313

1414
## Where to find the schedule settings
1515

0 commit comments

Comments
 (0)