Skip to content

docs: restructure docs #14182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 96 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
96 commits
Select commit Hold shift + click to select a range
13d4f56
docs offsite day 1
bpmct May 22, 2024
3cf73ed
updated coder tour and screenshots
stirby May 23, 2024
5bcaf81
edit manifest
bpmct May 23, 2024
e97dcba
incomplete info on schedule
stirby May 23, 2024
1352640
changes
bpmct May 23, 2024
56ef29e
rebase on `main`
matifali Aug 6, 2024
d9b2b76
removed stub on coder tour
stirby May 23, 2024
de4599c
workspace README page and tour cleanup
stirby May 23, 2024
2c277df
fixed tour MD linksg
stirby May 23, 2024
ad4bb0c
replaced broken pngs
stirby May 23, 2024
920ac48
moved workspace access to a directory
stirby May 23, 2024
133721a
rebase on `main`
matifali Aug 6, 2024
762b680
workspace access docs
stirby May 23, 2024
f74f54d
user guides manifest
stirby May 23, 2024
eab79b3
rebase on `main`
matifali Aug 6, 2024
af700c3
vscode
stirby May 23, 2024
442b6fd
add schedule
bpmct May 23, 2024
c4de546
title case for user guides
stirby May 24, 2024
248bbc2
workspace scheduling
stirby May 24, 2024
48bdc86
added workspace updating to main user guide
stirby May 24, 2024
39185ed
dotfiles page done
stirby May 24, 2024
0cc2d32
fleshed out vscode page
stirby May 24, 2024
bec25cb
weekend
stirby May 26, 2024
79ee974
templates
bpmct May 24, 2024
a3f2e84
integrations
stirby May 26, 2024
c0784a4
removed other platforms page
stirby May 26, 2024
1753902
cleanup
stirby May 29, 2024
90d92e1
some reorg and writing
bpmct May 27, 2024
03f5a93
migrated guides to tutorials
stirby May 30, 2024
ee2c576
infrastructure landing page
bpmct Jun 8, 2024
2dcf91e
add guide for creating templates
bpmct Jun 8, 2024
1907108
new format
bpmct Jun 8, 2024
1215e22
consider linking to tf
bpmct Jun 8, 2024
ca1a458
install landing page
bpmct Jun 8, 2024
9b55009
post pto sync
stirby Jun 12, 2024
6267964
in flight admin-workspace changes
stirby Jun 12, 2024
13716a1
fixing images in about page
stirby Jun 12, 2024
17fcea1
reference/cli proper structure
bpmct Jun 15, 2024
fc159ce
rebase on `main`
matifali Aug 6, 2024
330132b
rebase on `main`
matifali Aug 6, 2024
1efad16
fixups for cli and api gen
bpmct Jun 15, 2024
215a3ac
modify to look for Command Line nested in manifest
bpmct Jun 15, 2024
0041e8c
rebase on `main`
matifali Aug 6, 2024
822130a
wip
matifali Aug 6, 2024
293e07c
wip
matifali Aug 6, 2024
259668b
add screenshots
bpmct Jun 15, 2024
bcfe8ba
workspace lifecycle WIP
stirby Jun 20, 2024
dd73049
added workspace lifecycle to manifest for preview
stirby Jun 20, 2024
d6f2a8c
moved resource definition outside of user guides
stirby Jun 20, 2024
15592cb
fixed manifext typo
stirby Jun 20, 2024
875274d
rough draft of workspace lifecycle
stirby Jun 20, 2024
ce0cd54
cleaned up user guide for workspace scheduling
stirby Jun 20, 2024
d47245b
linked workspace scheduling guide in workspace lifecycle
stirby Jun 20, 2024
bc7db22
started 'extending templates' rearranged resource persistence
stirby Jun 22, 2024
2da48b9
copied secrets.md under admin/security
stirby Jun 24, 2024
5d07ed9
wip
matifali Aug 6, 2024
1235238
partial completion of admin/templates/extending-templates
stirby Jun 24, 2024
22c4a55
additional extending templates refactors
stirby Jun 24, 2024
8add1d7
finished 'extending templates' with variables.md from old docs
stirby Jun 24, 2024
51365cd
added manifest for extending templates
stirby Jun 24, 2024
3a46ccd
added secrets to manifest
stirby Jun 24, 2024
6c269eb
added FAQs as a subsection of guides. Going to keep them for now.
stirby Jul 19, 2024
9ac4f3f
migrated networking docs
stirby Jul 19, 2024
cf13803
added control plane configuration docs
stirby Jul 19, 2024
4098a8c
add integration guides
matifali Aug 6, 2024
34b2ed6
fix manifest
matifali Aug 6, 2024
5ca11b0
fmt and typos
matifali Aug 6, 2024
1447aea
fixup!
matifali Aug 6, 2024
d00cc9b
fix some links
matifali Aug 6, 2024
cafa035
fixup!
matifali Aug 6, 2024
7963a1a
`make fmt`
matifali Aug 6, 2024
aa7d43c
`make gen`
matifali Aug 6, 2024
adfc34c
`make fmt`
matifali Aug 6, 2024
1d21c9a
fixup!
matifali Aug 6, 2024
5f5b3d9
fix capitalization
matifali Aug 6, 2024
4e43821
add scaling to manifest
matifali Aug 6, 2024
0d20438
fix link
matifali Aug 6, 2024
0763b35
rebase on `main`
matifali Aug 7, 2024
bf5535c
rebase on `main`
matifali Aug 7, 2024
2e4b218
fmt and typos
matifali Aug 6, 2024
0996219
`make fmt`
matifali Aug 7, 2024
990d440
`make gen`
matifali Aug 7, 2024
66ff05e
chore: bump github.com/ory/dockertest/v3 from 3.10.0 to 3.11.0 (#14237)
dependabot[bot] Aug 12, 2024
3b099fd
added workspace proxies from lost branch
stirby Aug 13, 2024
2f14a08
chore(docs): move scaling docs under admin/infrastructure (#14270)
stirby Aug 15, 2024
ad16573
chore(docs): add WebRDP to restructure docs (#14385)
stirby Aug 21, 2024
579778e
wip
matifali Aug 22, 2024
e8eb3e4
fixup!
matifali Aug 22, 2024
4b9c2c6
fmt
matifali Aug 22, 2024
01707ec
add snap
matifali Aug 22, 2024
e034239
fixup!
matifali Aug 22, 2024
c021161
fix IDEs mess
matifali Aug 22, 2024
3ef9932
fmt
matifali Aug 23, 2024
d3b4b78
link change management
matifali Aug 23, 2024
18a498d
add terraform modules
matifali Aug 23, 2024
801d4fa
delete filebrowser
matifali Aug 23, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix some links
  • Loading branch information
matifali committed Aug 12, 2024
commit d00cc9b6995bbb34b8d607631027e91d5987f448
4 changes: 2 additions & 2 deletions docs/admin/integrations/jfrog-artifactory.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ two type of modules that automate the JFrog Artifactory and Coder integration.

This module is usable by JFrog self-hosted (on-premises) Artifactory as it
requires configuring a custom integration. This integration benefits from
Coder's [external-auth](https://coder.com/docs/v2/latest/admin/external-auth)
Coder's [external-auth](https://coder.com/docs/admin/external-auth)
feature and allows each user to authenticate with Artifactory using an OAuth
flow and issues user-scoped tokens to each user.

Expand Down Expand Up @@ -72,7 +72,7 @@ artifactory:
![JFrog Platform new integration](../images/guides/artifactory-integration/jfrog-oauth-app.png)

3. Add a new
[external authentication](https://coder.com/docs/v2/latest/admin/external-auth)
[external authentication](https://coder.com/docs/admin/external-auth)
to Coder by setting these env variables,

```env
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/templates/extending-templates/icons.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ come bundled with your Coder deployment.
}
```

- [**Authentication Providers**](https://coder.com/docs/v2/latest/admin/external-auth):
- [**Authentication Providers**](https://coder.com/docs/admin/external-auth):

- Use icons for external authentication providers to make them recognizable.
You can set an icon for each provider by setting the
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/users/oidc-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ OIDC provider will be added to the `myCoderGroupName` group in Coder.
### Group allowlist

You can limit which groups from your identity provider can log in to Coder with
[CODER_OIDC_ALLOWED_GROUPS](https://coder.com/docs/v2/latest/cli/server#--oidc-allowed-groups).
[CODER_OIDC_ALLOWED_GROUPS](https://coder.com/docs/reference/cli/server#--oidc-allowed-groups).
Users who are not in a matching group will see the following error:

![Unauthorized group error](../images/admin/group-allowlist.png)
Expand Down
4 changes: 2 additions & 2 deletions docs/admin/users/password-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ server.
## Restore the `Owner` user

If you remove the admin user account (or forget the password), you can run the
[`coder server create-admin-user`](https://coder.com/docs/v2/latest/cli/server_create-admin-user)
[`coder server create-admin-user`](https://coder.com/docs/reference/cli/server_create-admin-user)
command on your server.

> Note: You must run this command on the same machine running the Coder server.
Expand All @@ -24,4 +24,4 @@ command on your server.

An admin must reset passwords on behalf of users. This can be done in the web UI
in the Users page or CLI:
[`coder reset-password`](https://coder.com/docs/v2/latest/cli/reset-password)
[`coder reset-password`](https://coder.com/docs/cli/reset-password)
4 changes: 2 additions & 2 deletions docs/admin/users/sessions-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ for more info.
Today, you must use the REST API to generate a token on behalf of another user.
You must have the `Owner` role to do this. Use our API reference for more
information:
[Create token API key](https://coder.com/docs/v2/latest/api/users#create-token-api-key)
[Create token API key](https://coder.com/docs/reference/api/users#create-token-api-key)

### Set max token length

You can use the
[`CODER_MAX_TOKEN_LIFETIME`](https://coder.com/docs/v2/latest/cli/server#--max-token-lifetime)
[`CODER_MAX_TOKEN_LIFETIME`](https://coder.com/docs/reference/cli/server#--max-token-lifetime)
server flag to set the maximum duration for long-lived tokens in your
deployment.
4 changes: 2 additions & 2 deletions docs/install/other/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Coder has a number of alternate unofficial install methods. Contributions are we

| Platform Name | Status | Documentation |
| --------------------------------------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------- |
| AWS EC2 | Official | [Guide: AWS](https://coder.com/docs/v2/latest/platforms/aws) |
| Google Compute Engine | Official | [Guide: Google Compute Engine](https://coder.com/docs/v2/latest/platforms/gcp) |
| AWS EC2 | Official | [Guide: AWS](https://coder.com/docs/platforms/aws) |
| Google Compute Engine | Official | [Guide: Google Compute Engine](https://coder.com/docs/platforms/gcp) |
| Azure AKS | Unofficial | [GitHub: coder-aks](https://github.com/ericpaulsen/coder-aks) |
| Terraform (GKE, AKS, LKE, DOKS, IBMCloud K8s, OVHCloud K8s, Scaleway K8s Kapsule) | Unofficial | [GitHub: coder-oss-terraform](https://github.com/ElliotG/coder-oss-tf) |
| Fly.io | Unofficial | [Blog: Run Coder on Fly.io](https://coder.com/blog/remote-developer-environments-on-fly-io) |
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ Enterprise. These are hosted on our
request new topics to be covered.

<children>
This page is rendered on https://coder.com/docs/v2/latest/guides. Refer to the other documents in the `guides/` directory for specific employee-written guides.
This page is rendered on https://coder.com/docs/guides. Refer to the other documents in the `guides/` directory for specific employee-written guides.
</children>
4 changes: 2 additions & 2 deletions docs/tutorials/artifactory-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ two type of modules that automate the JFrog Artifactory and Coder integration.

This module is usable by JFrog self-hosted (on-premises) Artifactory as it
requires configuring a custom integration. This integration benefits from
Coder's [external-auth](https://coder.com/docs/v2/latest/admin/external-auth)
Coder's [external-auth](https://coder.com/docs/admin/external-auth)
feature and allows each user to authenticate with Artifactory using an OAuth
flow and issues user-scoped tokens to each user.

Expand Down Expand Up @@ -72,7 +72,7 @@ artifactory:
![JFrog Platform new integration](../images/guides/artifactory-integration/jfrog-oauth-app.png)

3. Add a new
[external authentication](https://coder.com/docs/v2/latest/admin/external-auth)
[external authentication](https://coder.com/docs/admin/external-auth)
to Coder by setting these env variables,

```env
Expand Down
6 changes: 3 additions & 3 deletions docs/tutorials/configuring-okta.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ December 13, 2023

To configure custom claims in Okta to support syncing roles and groups with
Coder, you must first have setup an Okta application with
[OIDC working with Coder](https://coder.com/docs/v2/latest/admin/auth#openid-connect).
[OIDC working with Coder](https://coder.com/docs/admin/auth#openid-connect).
From here, we will add additional claims for Coder to use for syncing groups and
roles.

Expand All @@ -39,14 +39,14 @@ be sent.

> !! If the user does not belong to any groups, the claim will not be sent. Make
> sure the user authenticating for testing is in at least 1 group. Defer to
> [troubleshooting](https://coder.com/docs/v2/latest/admin/auth#troubleshooting)
> [troubleshooting](https://coder.com/docs/admin/auth#troubleshooting)
> with issues

![Okta OpenID Connect ID Token](../images/guides/okta/oidc_id_token.png)

Configure Coder to use these claims for group sync. These claims are present in
the `id_token`. See all configuration options for group sync in the
[docs](https://coder.com/docs/v2/latest/admin/auth#group-sync-enterprise).
[docs](https://coder.com/docs/admin/auth#group-sync-enterprise).

```bash
# Add the 'groups' scope.
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/example-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ December 13, 2023
---

This is a guide on how to make Coder guides, it is not listed on our
[official guides page](https://coder.com/docs/v2/latest/guides) in the docs.
[official guides page](https://coder.com/docs/guides) in the docs.
Intended for those who don't frequently contribute documentation changes to the
`coder/coder` repository.

## Content

Defer to our
[Contributing/Documentation](https://coder.com/docs/v2/latest/contributing/documentation)
[Contributing/Documentation](https://coder.com/docs/contributing/documentation)
page for rules on technical writing.

### Adding Photos
Expand Down
16 changes: 8 additions & 8 deletions docs/tutorials/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The primary developer use case is a local IDE connecting over SSH to a Coder
workspace.

Coder's networking stack has intelligence to attempt a peer-to-peer or
[Direct connection](https://coder.com/docs/v2/latest/networking#direct-connections)
[Direct connection](https://coder.com/docs/networking#direct-connections)
between the local IDE and the workspace. However, this requires some additional
protocols like UDP and being able to reach a STUN server to echo the IP
addresses of the local IDE machine and workspace, for sharing using a Wireguard
Expand All @@ -58,9 +58,9 @@ troubleshooting.

| Flag | Value | Meaning |
| -------------------------------------------------------------------------------------------------------------- | ----------- | ------------------------------------- |
| [`CODER_BLOCK_DIRECT`](https://coder.com/docs/v2/latest/cli/server#--block-direct-connections) | `true` | Blocks direct connections |
| [`CODER_DERP_SERVER_STUN_ADDRESSES`](https://coder.com/docs/v2/latest/cli/server#--derp-server-stun-addresses) | `"disable"` | Disables STUN |
| [`CODER_DERP_FORCE_WEBSOCKETS`](https://coder.com/docs/v2/latest/cli/server#--derp-force-websockets) | `true` | Forces websockets over Tailscale DERP |
| [`CODER_BLOCK_DIRECT`](https://coder.com/docs/reference/cli/server#--block-direct-connections) | `true` | Blocks direct connections |
| [`CODER_DERP_SERVER_STUN_ADDRESSES`](https://coder.com/docs/reference/cli/server#--derp-server-stun-addresses) | `"disable"` | Disables STUN |
| [`CODER_DERP_FORCE_WEBSOCKETS`](https://coder.com/docs/reference/cli/server#--derp-force-websockets) | `true` | Forces websockets over Tailscale DERP |

### How do I configure NGINX as the reverse proxy in front of Coder?

Expand Down Expand Up @@ -125,7 +125,7 @@ An important concept to understand is that Coder creates workspaces which have
an agent that must be able to reach the `coder server`.

If the
[`CODER_ACCESS_URL`](https://coder.com/docs/v2/latest/admin/configure#access-url)
[`CODER_ACCESS_URL`](https://coder.com/docs/admin/configure#access-url)
is not accessible from a workspace, the workspace may build, but the agent
cannot reach Coder, and thus the missing icons. e.g., Terminal, IDEs, Apps.

Expand Down Expand Up @@ -155,7 +155,7 @@ of these values can lead to existing workspaces failing to start. This issue
occurs because the Terraform state will not be in sync with the new template.

However, a lesser-known CLI sub-command,
[`coder update`](https://coder.com/docs/v2/latest/cli/update), can resolve this
[`coder update`](https://coder.com/docs/reference/cli/update), can resolve this
issue. This command re-prompts users to re-enter the input variables,
potentially saving the workspace from a failed status.

Expand Down Expand Up @@ -296,12 +296,12 @@ References:

- [Public Github Issue 6117](https://github.com/coder/coder/issues/6117)
- [Public Github Issue 5677](https://github.com/coder/coder/issues/5677)
- [Coder docs: Templates/Change Management](https://coder.com/docs/v2/latest/templates/change-management)
- [Coder docs: Templates/Change Management](https://coder.com/docs/templates/change-management)

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

Yes, Coder can be deployed in air-gapped or offline mode.
https://coder.com/docs/v2/latest/install/offline
https://coder.com/docs/install/offline

Our product bundles with the Terraform binary so assume access to terraform.io
during installation. The docs outline rebuilding the Coder container with
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/xray-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ using Coder's [JFrog Xray Integration](https://github.com/coder/coder-xray).
[permission](https://jfrog.com/help/r/jfrog-platform-administration-documentation/permissions)
for the repositories you want to scan.
2. Create a Coder
[token](https://coder.com/docs/v2/latest/cli/tokens_create#tokens-create)
[token](https://coder.com/docs/reference/cli/tokens_create#tokens-create)
with a user that has the
[`owner`](https://coder.com/docs/v2/latest/admin/users#roles) role.
[`owner`](https://coder.com/docs/admin/users#roles) role.
3. Create kubernetes secrets for the JFrog Xray and Coder tokens.

```bash
Expand Down
4 changes: 2 additions & 2 deletions docs/user-guides/workspace-access/web-ides.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ resource "coder_app" "rstudio" {
```

If you cannot enable a
[wildcard subdomain](https://coder.com/docs/v2/latest/admin/configure#wildcard-access-url),
[wildcard subdomain](https://coder.com/docs/admin/configure#wildcard-access-url),
you can configure the template to run RStudio on a path using an NGINX reverse
proxy in the template. There is however
[security risk](https://coder.com/docs/v2/latest/cli/server#--dangerous-allow-path-app-sharing)
[security risk](https://coder.com/docs/reference/cli/server#--dangerous-allow-path-app-sharing)
running an app on a path and the template code is more complicated with coder
value substitution to recreate the path structure.

Expand Down