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

Skip to content

Commit 1fa31a6

Browse files
EdwardAngertEdwardAngert
committed
update links
1 parent 119c8e3 commit 1fa31a6

File tree

15 files changed

+63
-60
lines changed

15 files changed

+63
-60
lines changed

‎docs/admin/integrations/jfrog-xray.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -26,31 +26,31 @@ using Coder's [JFrog Xray Integration](https://github.com/coder/coder-xray).
2626
with a user that has the read
2727
[permission](https://jfrog.com/help/r/jfrog-platform-administration-documentation/permissions)
2828
for the repositories you want to scan.
29-
2. Create a Coder
29+
1. Create a Coder
3030
[token](https://coder.com/docs/latest/reference/cli/tokens_create#tokens-create)
3131
with a user that has the
3232
[`owner`](https://coder.com/docs/latest/admin/users#roles) role.
33-
3. Create kubernetes secrets for the JFrog Xray and Coder tokens.
34-
35-
```bash
36-
kubectl create secret generic coder-token --from-literal=coder-token='<token>'
37-
kubectl create secret generic jfrog-token --from-literal=user='<user>' --from-literal=token='<token>'
38-
```
39-
40-
4. Deploy the Coder - JFrog Xray integration.
41-
42-
```bash
43-
helm repo add coder-xray https://helm.coder.com/coder-xray
44-
45-
helm upgrade --install coder-xray coder-xray/coder-xray \
46-
--namespace coder-xray \
47-
--create-namespace \
48-
--set namespace="<CODER_WORKSPACES_NAMESPACE>" \ # Replace with your Coder workspaces namespace
49-
--set coder.url="https://<your-coder-url>" \
50-
--set coder.secretName="coder-token" \
51-
--set artifactory.url="https://<your-artifactory-url>" \
52-
--set artifactory.secretName="jfrog-token"
53-
```
33+
1. Create Kubernetes secrets for the JFrog Xray and Coder tokens.
34+
35+
```bash
36+
kubectl create secret generic coder-token --from-literal=coder-token='<token>'
37+
kubectl create secret generic jfrog-token --from-literal=user='<user>' --from-literal=token='<token>'
38+
```
39+
40+
1. Deploy the Coder - JFrog Xray integration.
41+
42+
```bash
43+
helm repo add coder-xray https://helm.coder.com/coder-xray
44+
45+
helm upgrade --install coder-xray coder-xray/coder-xray \
46+
--namespace coder-xray \
47+
--create-namespace \
48+
--set namespace="<CODER_WORKSPACES_NAMESPACE>" \ # Replace with your Coder workspaces namespace
49+
--set coder.url="https://<your-coder-url>" \
50+
--set coder.secretName="coder-token" \
51+
--set artifactory.url="https://<your-artifactory-url>" \
52+
--set artifactory.secretName="jfrog-token"
53+
```
5454

5555
### Updating the Coder template
5656

‎docs/admin/provisioners.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,19 @@ are sometimes benefits to running external provisioner daemons:
1010

1111
- **Isolate APIs:** Deploy provisioners in isolated environments (on-prem, AWS,
1212
Azure) instead of exposing APIs (Docker, Kubernetes, VMware) to the Coder
13-
server. See [Provider Authentication](../templates/authentication.md) for more
13+
server. See [Provider Authentication](../admin/external-auth.md) for more
1414
details.
1515

1616
- **Isolate secrets**: Keep Coder unaware of cloud secrets, manage/rotate
1717
secrets on provisioner servers.
1818

1919
- **Reduce server load**: External provisioners reduce load and build queue
2020
times from the Coder server. See
21-
[Scaling Coder](scaling/scale-utility.md#recent-scale-tests) for more details.
21+
[Scaling Coder](../admin/infrastructure/scale-utility.md#recent-scale-tests)
22+
for more details.
2223

2324
Each provisioner can run a single
24-
[concurrent workspace build](scaling/scale-testing.md#control-plane-provisionerd).
25+
[concurrent workspace build](../admin/infrastructure/scale-testing.md#control-plane-provisionerd).
2526
For example, running 30 provisioner containers will allow 30 users to start
2627
workspaces at the same time.
2728

@@ -264,7 +265,7 @@ docker run --rm -it \
264265

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

269270
```shell
270271
coder server --provisioner-daemons=0

‎docs/admin/templates/extending-templates/web-ides.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ resource "coder_app" "jupyter" {
185185
}
186186
```
187187

188-
Or Alternatively, you can use the Jypyter Lab module from the Coder registry:
188+
Or Alternatively, you can use the JupyterLab module from the Coder registry:
189189

190190
```tf
191191
module "jupyter" {
@@ -196,13 +196,13 @@ module "jupyter" {
196196
```
197197

198198
If you cannot enable a
199-
[wildcard subdomain](https://coder.com/docs/admin/configure#wildcard-access-url),
200-
you can configure the template to run Jupyter on a path. There is however
201-
[security risk](https://coder.com/docs/reference/cli/server#--dangerous-allow-path-app-sharing)
199+
[wildcard subdomain](../../../admin/setup.md#wildcard-access-url), you can
200+
configure the template to run Jupyter on a path. There is however
201+
[security risk](../../../reference/cli/server#--dangerous-allow-path-app-sharing)
202202
running an app on a path and the template code is more complicated with coder
203203
value substitution to recreate the path structure.
204204

205-
![JupyterLab in Coder](../../../../images/jupyterlab.png)
205+
![JupyterLab in Coder](../../../images/jupyter.png)
206206

207207
## RStudio
208208

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Working with templates
22

3-
You create and edit Coder templates as [Terraform](./tour.md) configuration
3+
You create and edit Coder templates as [Terraform](../../../start/coder-tour.md) configuration
44
files (`.tf`) and any supporting files, like a README or configuration files for
55
other services.
66

‎docs/admin/templates/managing-templates/change-management.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ automating the creation of new versions in CI/CD pipelines.
55

66
These pipelines will require tokens for your deployment. To cap token lifetime
77
on creation,
8-
[configure Coder server to set a shorter max token lifetime](../reference/cli/server.md#--max-token-lifetime).
8+
[configure Coder server to set a shorter max token lifetime](../../../reference/cli/server.md#--max-token-lifetime).
99

1010
## coderd Terraform Provider
1111

@@ -62,8 +62,8 @@ For an example, see how we push our development image and template
6262

6363
## Coder CLI
6464

65-
You can also [install Coder](../install/) to automate pushing new template
66-
versions in CI/CD pipelines.
65+
You can also [install Coder](../../../install/cli.md) to automate pushing new
66+
template versions in CI/CD pipelines.
6767

6868
```console
6969
# Install the Coder CLI

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,8 @@ 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/README.md#suspend-a-user) and are not deleted.
138-
[Configure](./configure.md) your SCIM application with an auth key and supply it
139-
the Coder server.
137+
[suspended](../users/README.md#suspend-a-user) and are not deleted. Configure
138+
your SCIM application with an auth key and supply it the Coder server.
140139

141140
```env
142141
CODER_SCIM_AUTH_HEADER="your-api-key"

‎docs/faqs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,9 +117,9 @@ resource "coder_app" "code-server" {
117117
An important concept to understand is that Coder creates workspaces which have
118118
an agent that must be able to reach the `coder server`.
119119

120-
If the [`CODER_ACCESS_URL`](./admin/setup#access-url) is not accessible
121-
from a workspace, the workspace may build, but the agent cannot reach Coder, and
122-
thus the missing icons. e.g., Terminal, IDEs, Apps.
120+
If the [`CODER_ACCESS_URL`](./admin/setup#access-url) is not accessible from a
121+
workspace, the workspace may build, but the agent cannot reach Coder, and thus
122+
the missing icons. e.g., Terminal, IDEs, Apps.
123123

124124
> By default, `coder server` automatically creates an Internet-accessible
125125
> reverse proxy so that workspaces you create can reach the server.

‎docs/start/coder-tour.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,8 @@ This starter template lets you connect to your workspace in a few ways:
128128
- VS Code Desktop: Loads your workspace into
129129
[VS Code Desktop](https://code.visualstudio.com/Download) installed on your
130130
local computer.
131-
- code-server: Opens [browser-based VS Code](../ides/web-ides.md) with your
131+
- code-server: Opens
132+
[browser-based VS Code](../user-guides/workspace-access/vscode.md) with your
132133
workspace.
133134
- Terminal: Opens a browser-based terminal with a shell in the workspace's
134135
Docker instance.
@@ -137,7 +138,7 @@ This starter template lets you connect to your workspace in a few ways:
137138
configure your SSH client.
138139

139140
> **Tip**: You can edit the template to let developers connect to a workspace in
140-
> [a few more ways](../ides.md).
141+
> [a few more ways](../admin/templates/managing-templates/devcontainers.md).
141142
142143
When you're done, you can stop the workspace.
143144

@@ -181,5 +182,6 @@ Python 3 instead of Go.
181182
For developers with workspaces that were created with a previous version of your
182183
template, Coder will notify them that there's a new version of the template.
183184

184-
You can also handle [change management](./change-management.md) through your own
185-
repo and continuous integration.
185+
You can also handle
186+
[change management](../admin/templates/managing-templates/change-management.md)
187+
through your own repo and continuous integration.

‎docs/start/first-template.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,10 +120,10 @@ Python 3 instead of Go.
120120
For developers with workspaces that were created with a previous version of your
121121
template, Coder will notify them that there's a new version of the template.
122122

123-
You can also handle [change management](./change-management.md) through your own
124-
repo and continuous integration.
123+
You can also handle
124+
[change management](../admin/templates/managing-templates/change-management.md)
125+
through your own repo and continuous integration.
125126

126127
## Next steps
127128

128-
- [Write your own template](./tour.md)
129-
- [Setting up templates](./best-practices.md)
129+
- [Setting up templates](../admin/templates/creating-templates.md)

‎docs/start/first-workspace.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ same resources.
1212
## Before you begin
1313

1414
This guide will use the Docker template from the
15-
[previous step](../tutorials/template-from-scratch.md) to create and connect to a Coder workspace.
15+
[previous step](../tutorials/template-from-scratch.md) to create and connect to
16+
a Coder workspace.
1617

1718
## 1. Create a workspace from your template through the GUI
1819

‎docs/tutorials/faqs.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,8 @@ References:
299299

300300
### Can I run Coder in an air-gapped or offline mode? (no Internet)?
301301

302-
Yes, Coder can be deployed in [air-gapped or offline mode](../install/offline.md).
302+
Yes, Coder can be deployed in
303+
[air-gapped or offline mode](../install/offline.md).
303304

304305
Our product bundles with the Terraform binary so assume access to terraform.io
305306
during installation. The docs outline rebuilding the Coder container with

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ with Ubuntu.
1111
To follow this guide, you'll need:
1212

1313
- A computer or cloud computing instance with both
14-
[Docker](https://docs.docker.com/get-docker/) and [Coder](../install/index.md)
15-
installed on it.
14+
[Docker](https://docs.docker.com/get-docker/) and
15+
[Coder](../install/README.md) installed on it.
1616

1717
> When setting up your computer or computing instance, make sure to install
1818
> Docker first, then Coder. Otherwise, you'll need to add the `coder` user to
@@ -194,7 +194,7 @@ resource "coder_agent" "main" {
194194
Because Docker is running locally in the Coder server, there is no need to
195195
authenticate `coder_agent`. But if your `coder_agent` were running on a remote
196196
host, your template would need
197-
[authentication credentials](./authentication.md).
197+
[authentication credentials](../admin/external-auth.md).
198198

199199
This template's agent also runs a startup script, sets environment variables,
200200
and provides metadata.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ manually setting up an SSH connection.
4040

4141
![Gateway Connect to Coder](../../images/gateway/plugin-connect-to-coder.png)
4242

43-
1. Enter your Coder deployment's
44-
[Access Url](../../admin/setup.md#access-url) and click **Connect**.
43+
1. Enter your Coder deployment's [Access Url](../../admin/setup.md#access-url)
44+
and click **Connect**.
4545

4646
Gateway opens your Coder deployment's `cli-auth` page with a session token.
4747
Click the copy button, paste the session token in the Gateway **Session

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ For more examples, see `coder port-forward --help`.
5353
## Dashboard
5454

5555
> To enable port forwarding via the dashboard, Coder must be configured with a
56-
> [wildcard access URL](../admin/setup.md#wildcard-access-url). If an access
57-
> URL is not specified, Coder will create
56+
> [wildcard access URL](../admin/setup.md#wildcard-access-url). If an access URL
57+
> is not specified, Coder will create
5858
> [a publicly accessible URL](../admin/setup.md#tunnel) to reverse proxy the
5959
> deployment, and port forwarding will work.
6060
>

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,7 @@ There are multiple ways to add extensions to VS Code Desktop:
3737
1. Using the
3838
[public extensions marketplaces](#using-the-public-extensions-marketplaces)
3939
with Code Web (code-server)
40-
1. Adding
41-
[extensions to custom images](#adding-extensions-to-custom-images)
40+
1. Adding [extensions to custom images](#adding-extensions-to-custom-images)
4241
1. Installing extensions
4342
[using its `vsix` file at the command line](#installing-extensions-using-its-vsix-file-at-the-command-line)
4443
1. Installing extensions

0 commit comments

Comments
 (0)