Skip to content
This repository was archived by the owner on Aug 18, 2025. It is now read-only.

Commit a078b86

Browse files
author
Katie Horne
authored
Hide Guides navigation (#180)
1 parent 7f883e9 commit a078b86

File tree

15 files changed

+91
-49
lines changed

15 files changed

+91
-49
lines changed
File renamed without changes.

guides/admin/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Admin Guides"
3+
description: Learn about admin tasks for Coder.
4+
---
5+
6+
<children></children>

guides/resources.md renamed to guides/admin/resources.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ each machine would see 100% utilization of its resources. However, these
2323
processes are relatively quick, so the machine is underutilized the vast
2424
majority of the time.
2525

26-
![resources-nonshared.svg](../assets/resources-old.svg)
26+
![resources-nonshared.svg](../../assets/resources-old.svg)
2727

2828
However, sharing resources can allow you to provide your developers with access
2929
to the computing resources while minimizing underutilization.
@@ -35,7 +35,7 @@ resources they need during peak load (e.g., compilation, build); this offers
3535
them a performant experience when required. However, the shared resources
3636
minimize resource underutilization.
3737

38-
![resources-shared.svg](../assets/resources-new.svg)
38+
![resources-shared.svg](../../assets/resources-new.svg)
3939

4040
## Resource Contention
4141

@@ -60,4 +60,4 @@ compute costs:
6060
- The Coder organization's environment inactivity shutdown threshold
6161
- The magnitude and frequency of code compilation operations
6262

63-
![cpu_provision_ratio.png](../assets/cpu_provision_ratio.png)
63+
![cpu_provision_ratio.png](../../assets/cpu_provision_ratio.png)

guides/usage-monitoring.md renamed to guides/admin/usage-monitoring.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ contention can result in the throttling of developer environments, while
1616
excessive underutilization suggests that you may be spending more on your cloud
1717
environment than necessary.
1818

19-
![Monitoring CPU Utilization](../assets/compute-1.png)
19+
![Monitoring CPU Utilization](../../assets/compute-1.png)
2020

21-
![Monitoring Memory Utilization](../assets/compute-2.png)
21+
![Monitoring Memory Utilization](../../assets/compute-2.png)
2222

2323
There are several tools available to you to balance the tradeoff between
2424
environment performance and cloud cost. Read more about this on [compute
@@ -31,9 +31,9 @@ cluster resources to Coder's product-level resource identifiers. For example,
3131
the following chart tracks the CPU/Memory Limit Utilization of each environment
3232
container and labels them with the username and environment name identifiers:
3333

34-
![Monitoring CPU Utilization by Environment and User](../assets/compute-3.png)
34+
![Monitoring CPU Utilization by Environment and User](../../assets/compute-3.png)
3535

36-
![Monitoring Memory Utilization by Environment and User](../assets/compute-4.png)
36+
![Monitoring Memory Utilization by Environment and User](../../assets/compute-4.png)
3737

3838
These views can help you track which users may require larger CPU allocations,
3939
enabling greater "burst-ability" under peak loads. However, remember that using
@@ -46,8 +46,8 @@ Monitoring the Coder control plane can help you maintain high uptime. For
4646
example, the following charts provide high-level insight into the state of the
4747
Coder API server:
4848

49-
![Monitoring Log Event Severity](../assets/compute-5.png)
49+
![Monitoring Log Event Severity](../../assets/compute-5.png)
5050

51-
![Monitoring API Status Codes](../assets/compute-6.png)
51+
![Monitoring API Status Codes](../../assets/compute-6.png)
5252

53-
![Monitoring HTTP Latency](../assets/compute-7.png)
53+
![Monitoring HTTP Latency](../../assets/compute-7.png)

guides/custom-env.md renamed to guides/customization/custom-env.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ Make sure that you've:
1818
- Given your image building tool the rights needed to push to a [Docker
1919
Registry](https://docs.docker.com/registry/introduction/) (e.g., [Docker
2020
Hub](https://hub.docker.com/))
21-
- (Optional) Configured [Dev URLs](../admin/devurls.md) for your deployment
21+
- (Optional) Configured [Dev URLs](../../admin/devurls.md) for your deployment
2222

2323
Your Coder user account must have permissions to [import an
24-
image](../images/importing.md).
24+
image](../../images/importing.md).
2525

2626
## Step 1: Create a Development Image
2727

@@ -197,7 +197,7 @@ yarn start
197197
### Preview Your Application
198198

199199
Once you've started your server, you can preview your application using the web
200-
browser of your choice (you must have [Dev URLs](../admin/devurls.md) enabled
200+
browser of your choice (you must have [Dev URLs](../../admin/devurls.md) enabled
201201
for this to work). To do so:
202202

203203
1. On the Environment Overview of your Coder deployment, go to Dev URLs and

guides/gitconfig.md renamed to guides/customization/gitconfig.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ Coder will create a global git configuration file located at `~/.gitconfig` in a
1111
newly created environments and set the user name and email address using the
1212
information associated with the user's Coder account.
1313

14-
This step occurs before [coder/configure](https://coder.com/docs/images/configure)
15-
and [personalization](https://coder.com/docs/environments/personalization),
14+
This step occurs before [coder/configure](images/../../../images/configure.md)
15+
and [personalization](../../environments/personalization.md),
1616
which can be used to override the default `.gitconfig` created by Coder.
1717
If there's already a `.gitconfig` file, Coder will not recreate a default
1818
version when you rebuild an environment.
1919

2020
We recommend that each Coder user set and modify their personal .gitconfig file
21-
using the [~/personalize script](../environments/personalization.md).
21+
using the [~/personalize script](../../environments/personalization.md).
2222

2323
**Preferences defined using individual `.gitconfig` files take precedence over
2424
system-level settings.**

guides/customization/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Customization Guides"
3+
description: Learn about tasks related to customizing Coder.
4+
---
5+
6+
<children></children>

guides/macos-keybinding.md renamed to guides/customization/macos-keybinding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ To switch the keybindings:
1616
5. Use the **Keymap** toggle at the top to switch to **macOS**
1717
6. Click **OK** to save your changes and proceed
1818

19-
![Configuring macOS Keybindings](../assets/macos-keybinding.png)
19+
![Configuring macOS Keybindings](../../assets/macos-keybinding.png)

guides/deployments/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Deployment Guides"
3+
description: Learn about tasks related to deploying Coder.
4+
---
5+
6+
<children></children>

guides/keycloak.md renamed to guides/deployments/keycloak.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Administration Guide's [Identity
1111
Brokering](https://www.keycloak.org/docs/latest/server_admin/#_identity_broker)
1212
section.
1313

14-
![Identity Broker Process](../assets/SAML-process.png)
14+
![Identity Broker Process](../../assets/SAML-process.png)
1515

1616
## Step 1: Create a New Realm in Keycloak
1717

@@ -53,7 +53,7 @@ to OIDC Bridge`.
5353
1. At this point, you should be able to open the **Application Configuration**
5454
backup on JumpCloud and export the IdP metadata to use with Keycloak.
5555

56-
![Export SAML Metadata](../assets/SAML-config-2.png)
56+
![Export SAML Metadata](../../assets/SAML-config-2.png)
5757

5858
1. On the **User Groups** tab, add the JumpCloud User Group(s) that need access
5959
to Coder.
@@ -68,51 +68,51 @@ to OIDC Bridge`.
6868
document](https://www.keycloak.org/docs/latest/server_admin/#saml-v2-0-identity-providers)
6969
provides additional information about adding a SAML 2.0 Identity Provider).
7070

71-
![Keycloak Identity Providers](../assets/keycloak-identity-providers.png)
71+
![Keycloak Identity Providers](../../assets/keycloak-identity-providers.png)
7272

7373
1. On the IdP configuration page, specify an **Alias** to use for your IdP
7474
provider.
7575

7676
1. Scroll to the bottom of the configuration page and upload the IdP metadata
7777
you exported from JumpCloud.
7878

79-
![Keycloak Metadata Import](../assets/keycloak-metadata-import.png)
79+
![Keycloak Metadata Import](../../assets/keycloak-metadata-import.png)
8080

8181
### Optional: Specify JumpCloud as the Default IdP
8282

8383
1. Navigate to **Authentication**.
8484

8585
2. Select the **Browser** flow from the dropdown in the top-left.
8686

87-
![Default Identity Provider](../assets/keycloak-default-IdP.png)
87+
![Default Identity Provider](../../assets/keycloak-default-IdP.png)
8888

8989
1. Find the **Identity Provider Redirector** row and click **Actions** >
9090
**Config**.
9191

92-
![Identity Provider Redirector](../assets/keycloak-IdP-redirector.png)
92+
![Identity Provider Redirector](../../assets/keycloak-IdP-redirector.png)
9393

9494
1. Set **Alias** and **Default Identity Provider** to the alias of the identity
9595
provider you created earlier.
9696

97-
![Authenticator Config](../assets/keycloak-authenticator-config.png)
97+
![Authenticator Config](../../assets/keycloak-authenticator-config.png)
9898

9999
## Step 4: Configure the OpenID Connect (OIDC) Connector in Keycloak
100100

101101
1. Navigate to **Clients** and click **Create**.
102102

103-
![Create Client Connector](../assets/keycloak-create-client.png)
103+
![Create Client Connector](../../assets/keycloak-create-client.png)
104104

105105
1. Add a new OIDC Client to point to your Coder deployment and click **Save**.
106106

107-
![Add OIDC client](../assets/keycloak-add-client.png)
107+
![Add OIDC client](../../assets/keycloak-add-client.png)
108108

109109
1. Once on the **Clients** configuration page, set the **Access Type** to
110110
**Confidential** and click **Save**.
111111

112112
1. Your client configuration should look something like the following (make sure
113113
that all of the values point to your Coder deployment):
114114

115-
![Client Configuration](../assets/keycloak-client-config.png)
115+
![Client Configuration](../../assets/keycloak-client-config.png)
116116

117117
At this point, you can configure your Coder deployment to use the Keycloak OIDC
118118
Connector.
@@ -128,12 +128,12 @@ At this point, you can configure your Coder deployment to use the Keycloak OIDC
128128
1. Add the **Secret** to the **Client Secret** field (you can get this value
129129
from the **Credentials** page in the Keycloak Clients Configuration).
130130

131-
![Keycloak Secret](../assets/keycloak-secret.png)
131+
![Keycloak Secret](../../assets/keycloak-secret.png)
132132

133133
1. Add your Keycloak instance and Realm as the `Issuer`. This will be a URL
134134
formatted as follows: `https://<my-keycloak-url>/auth/realms/<my-realm>`
135135

136-
![Coder Keycloak Config](../assets/keycloak-coder-config.png)
136+
![Coder Keycloak Config](../../assets/keycloak-coder-config.png)
137137

138138
1. Click **Save Preferences**.
139139

0 commit comments

Comments
 (0)