Skip to content

Commit 419eba5

Browse files
matifaliethanndicksonbpmctstirbyEdwardAngert
authored
docs: restructure docs (#14421)
Closes #13434 Supersedes #14182 --------- Co-authored-by: Ethan <39577870+ethanndickson@users.noreply.github.com> Co-authored-by: Ethan Dickson <ethan@coder.com> Co-authored-by: Ben Potter <ben@coder.com> Co-authored-by: Stephen Kirby <58410745+stirby@users.noreply.github.com> Co-authored-by: Stephen Kirby <me@skirby.dev> Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>
1 parent 288df75 commit 419eba5

File tree

298 files changed

+4967
-3847
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

298 files changed

+4967
-3847
lines changed

‎.github/workflows/typos.toml

+1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ pn = "pn"
2222
EDE = "EDE"
2323
# HELO is an SMTP command
2424
HELO = "HELO"
25+
LKE = "LKE"
2526

2627
[files]
2728
extend-exclude = [

‎.vscode/settings.json

+23-2
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,37 @@
66
"ASKPASS",
77
"authcheck",
88
"autostop",
9+
"autoupdate",
910
"awsidentity",
1011
"bodyclose",
1112
"buildinfo",
1213
"buildname",
14+
"Caddyfile",
1315
"circbuf",
1416
"cliflag",
1517
"cliui",
1618
"codecov",
19+
"codercom",
1720
"coderd",
1821
"coderdenttest",
1922
"coderdtest",
2023
"codersdk",
2124
"contravariance",
2225
"cronstrue",
2326
"databasefake",
27+
"dbcrypt",
2428
"dbgen",
2529
"dbmem",
2630
"dbtype",
2731
"DERP",
2832
"derphttp",
2933
"derpmap",
34+
"devcontainers",
3035
"devel",
3136
"devtunnel",
3237
"dflags",
38+
"dogfood",
39+
"dotfiles",
3340
"drpc",
3441
"drpcconn",
3542
"drpcmux",
@@ -38,18 +45,22 @@
3845
"embeddedpostgres",
3946
"enablements",
4047
"enterprisemeta",
48+
"Entra",
4149
"errgroup",
4250
"eventsourcemock",
4351
"externalauth",
4452
"Failf",
4553
"fatih",
54+
"filebrowser",
4655
"Formik",
4756
"gitauth",
57+
"Gitea",
4858
"gitsshkey",
4959
"goarch",
5060
"gographviz",
5161
"goleak",
5262
"gonet",
63+
"googleclouddns",
5364
"gossh",
5465
"gsyslog",
5566
"GTTY",
@@ -63,9 +74,11 @@
6374
"initialisms",
6475
"ipnstate",
6576
"isatty",
77+
"jetbrains",
6678
"Jobf",
6779
"Keygen",
6880
"kirsle",
81+
"knowledgebase",
6982
"Kubernetes",
7083
"ldflags",
7184
"magicsock",
@@ -77,6 +90,7 @@
7790
"namesgenerator",
7891
"namespacing",
7992
"netaddr",
93+
"netcheck",
8094
"netip",
8195
"netmap",
8296
"netns",
@@ -93,13 +107,16 @@
93107
"opty",
94108
"paralleltest",
95109
"parameterscopeid",
110+
"portsharing",
96111
"pqtype",
97112
"prometheusmetrics",
98113
"promhttp",
99114
"protobuf",
100115
"provisionerd",
101116
"provisionerdserver",
102117
"provisionersdk",
118+
"psql",
119+
"ptrace",
103120
"ptty",
104121
"ptys",
105122
"ptytest",
@@ -114,6 +131,7 @@
114131
"Signup",
115132
"slogtest",
116133
"sourcemapped",
134+
"speedtest",
117135
"spinbutton",
118136
"Srcs",
119137
"stdbuf",
@@ -154,13 +172,15 @@
154172
"turnconn",
155173
"typegen",
156174
"typesafe",
175+
"unauthenticate",
157176
"unconvert",
158-
"Untar",
159-
"Userspace",
177+
"untar",
178+
"userspace",
160179
"VMID",
161180
"walkthrough",
162181
"weblinks",
163182
"webrtc",
183+
"websockets",
164184
"wgcfg",
165185
"wgconfig",
166186
"wgengine",
@@ -172,6 +192,7 @@
172192
"workspaceapps",
173193
"workspacebuilds",
174194
"workspacename",
195+
"workspaceproxies",
175196
"wsjson",
176197
"xerrors",
177198
"xlarge",

‎Makefile

+12-13
Original file line numberDiff line numberDiff line change
@@ -495,9 +495,9 @@ gen: \
495495
coderd/rbac/object_gen.go \
496496
codersdk/rbacresources_gen.go \
497497
site/src/api/rbacresourcesGenerated.ts \
498-
docs/admin/prometheus.md \
499-
docs/reference/cli/README.md \
500-
docs/admin/audit-logs.md \
498+
docs/admin/integrations/prometheus.md \
499+
docs/reference/cli/index.md \
500+
docs/admin/security/audit-logs.md \
501501
coderd/apidoc/swagger.json \
502502
.prettierignore.include \
503503
.prettierignore \
@@ -525,9 +525,9 @@ gen/mark-fresh:
525525
coderd/rbac/object_gen.go \
526526
codersdk/rbacresources_gen.go \
527527
site/src/api/rbacresourcesGenerated.ts \
528-
docs/admin/prometheus.md \
529-
docs/reference/cli/README.md \
530-
docs/admin/audit-logs.md \
528+
docs/admin/integrations/prometheus.md \
529+
docs/reference/cli/index.md \
530+
docs/admin/security/audit-logs.md \
531531
coderd/apidoc/swagger.json \
532532
.prettierignore.include \
533533
.prettierignore \
@@ -638,21 +638,20 @@ codersdk/rbacresources_gen.go: scripts/rbacgen/codersdk.gotmpl scripts/rbacgen/m
638638
site/src/api/rbacresourcesGenerated.ts: scripts/rbacgen/codersdk.gotmpl scripts/rbacgen/main.go coderd/rbac/object.go coderd/rbac/policy/policy.go
639639
go run scripts/rbacgen/main.go typescript > "$@"
640640

641-
642-
docs/admin/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/metrics
641+
docs/admin/integrations/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/metrics
643642
go run scripts/metricsdocgen/main.go
644643
./scripts/pnpm_install.sh
645-
pnpm exec prettier --write ./docs/admin/prometheus.md
644+
pnpm exec prettier --write ./docs/admin/integrations/prometheus.md
646645

647-
docs/reference/cli/README.md: scripts/clidocgen/main.go examples/examples.gen.json $(GO_SRC_FILES)
646+
docs/reference/cli/index.md: scripts/clidocgen/main.go examples/examples.gen.json $(GO_SRC_FILES)
648647
CI=true BASE_PATH="." go run ./scripts/clidocgen
649648
./scripts/pnpm_install.sh
650-
pnpm exec prettier --write ./docs/reference/cli/README.md ./docs/reference/cli/*.md ./docs/manifest.json
649+
pnpm exec prettier --write ./docs/reference/cli/index.md ./docs/reference/cli/*.md ./docs/manifest.json
651650

652-
docs/admin/audit-logs.md: coderd/database/querier.go scripts/auditdocgen/main.go enterprise/audit/table.go coderd/rbac/object_gen.go
651+
docs/admin/security/audit-logs.md: coderd/database/querier.go scripts/auditdocgen/main.go enterprise/audit/table.go coderd/rbac/object_gen.go
653652
go run scripts/auditdocgen/main.go
654653
./scripts/pnpm_install.sh
655-
pnpm exec prettier --write ./docs/admin/audit-logs.md
654+
pnpm exec prettier --write ./docs/admin/security/audit-logs.md
656655

657656
coderd/apidoc/swagger.json: $(shell find ./scripts/apidocgen $(FIND_EXCLUSIONS) -type f) $(wildcard coderd/*.go) $(wildcard enterprise/coderd/*.go) $(wildcard codersdk/*.go) $(wildcard enterprise/wsproxy/wsproxysdk/*.go) $(DB_GEN_FILES) .swaggo docs/manifest.json coderd/rbac/object_gen.go
658657
./scripts/apidocgen/generate.sh

‎docs/CONTRIBUTING.md

+3
Original file line numberDiff line numberDiff line change
@@ -315,6 +315,9 @@ Breaking changes can be triggered in two ways:
315315

316316
### Security
317317

318+
> If you find a vulnerability, **DO NOT FILE AN ISSUE**. Instead, send an email
319+
> to security@coder.com.
320+
318321
The
319322
[`security`](https://github.com/coder/coder/issues?q=sort%3Aupdated-desc+label%3Asecurity)
320323
label can be added to PRs that have, or will be, merged into `main`. Doing so

‎docs/README.md

+29-21
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
# About Coder
22

3+
<!-- Warning for docs contributors: The first route in manifest.json must be titled "About" for the static landing page to work correctly. -->
4+
35
Coder is an open-source platform for creating and managing developer workspaces
46
on your preferred clouds and servers.
57

68
<p align="center">
79
<img src="./images/hero-image.png">
810
</p>
911

10-
By building on top of common development interfaces (SSH) and infrastructure tools (Terraform), Coder aims to make the process of **provisioning** and **accessing** remote workspaces approachable for organizations of various sizes and stages of cloud-native maturity.
12+
By building on top of common development interfaces (SSH) and infrastructure
13+
tools (Terraform), Coder aims to make the process of **provisioning** and
14+
**accessing** remote workspaces approachable for organizations of various sizes
15+
and stages of cloud-native maturity.
1116

1217
<blockquote class="warning">
1318
<p>
@@ -18,21 +23,28 @@ By building on top of common development interfaces (SSH) and infrastructure too
1823
## How it works
1924

2025
Coder workspaces are represented with Terraform, but no Terraform knowledge is
21-
required to get started. We have a database of pre-made templates built into the
22-
product.
26+
required to get started. We have a
27+
[database](https://registry.coder.com/templates) of pre-made templates built
28+
into the product.
2329

2430
<p align="center">
2531
<img src="./images/providers-compute.png">
2632
</p>
2733

28-
Coder workspaces don't stop at compute. You can add storage buckets, secrets, sidecars
29-
and whatever else Terraform lets you dream up.
34+
Coder workspaces don't stop at compute. You can add storage buckets, secrets,
35+
sidecars and whatever else Terraform lets you dream up.
3036

31-
[Learn more about managing infrastructure.](./templates/index.md)
37+
[Learn more about templates.](./admin/templates/index.md)
3238

3339
## IDE Support
3440

35-
You can use any Web IDE ([code-server](https://github.com/coder/code-server), [projector](https://github.com/JetBrains/projector-server), [Jupyter](https://jupyter.org/), etc.), [JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/), [VS Code Remote](https://code.visualstudio.com/docs/remote/ssh-tutorial) or even a file sync such as [mutagen](https://mutagen.io/).
41+
You can use any [Web IDE](./admin/templates/extending-templates/web-ides.md)
42+
([code-server](https://github.com/coder/code-server),
43+
[projector](https://github.com/JetBrains/projector-server),
44+
[Jupyter](https://jupyter.org), etc.),
45+
[JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/),
46+
[VS Code Remote](https://code.visualstudio.com/docs/remote/ssh-tutorial) or even
47+
a file sync such as [mutagen](https://mutagen.io/).
3648

3749
<p align="center">
3850
<img src="./images/ide-icons.svg" height=72>
@@ -41,11 +53,11 @@ You can use any Web IDE ([code-server](https://github.com/coder/code-server), [p
4153
## Why remote development
4254

4355
Migrating from local developer machines to workspaces hosted by cloud services
44-
is an [increasingly common solution for
45-
developers](https://blog.alexellis.io/the-internet-is-my-computer/) and
46-
[organizations
47-
alike](https://slack.engineering/development-environments-at-slack). There are
48-
several benefits, including:
56+
is an
57+
[increasingly common solution for developers](https://blog.alexellis.io/the-internet-is-my-computer/)
58+
and
59+
[organizations alike](https://slack.engineering/development-environments-at-slack).
60+
There are several benefits, including:
4961

5062
- **Increased speed:** Server-grade compute speeds up operations in software
5163
development, such as IDE loading, code compilation and building, and the
@@ -80,8 +92,9 @@ layer of infrastructure control. This additional layer allows admins to:
8092
- Enable persistent workspaces, which are like local machines, but faster and
8193
hosted by a cloud service
8294

83-
Coder includes [production-ready templates](https://github.com/coder/coder/tree/c6b1daabc5a7aa67bfbb6c89966d728919ba7f80/examples/templates) for use with AWS EC2,
84-
Azure, Google Cloud, Kubernetes, and more.
95+
Coder includes
96+
[production-ready templates](https://registry.coder.com/templates) for use with
97+
AWS EC2, Azure, Google Cloud, Kubernetes, and more.
8598

8699
## What Coder is _not_
87100

@@ -99,10 +112,5 @@ Azure, Google Cloud, Kubernetes, and more.
99112
- Coder is not a collaboration platform. You can use git and dedicated IDE
100113
extensions for pull requests, code reviews, and pair programming.
101114

102-
- Coder is not a SaaS/fully-managed offering. You must host
103-
Coder on a cloud service (AWS, Azure, GCP) or your private data center.
104-
105-
## Up next
106-
107-
- Learn about [Templates](./templates/index.md)
108-
- [Install Coder](./install/index.md#install-coder)
115+
- Coder is not a SaaS/fully-managed offering. You must host Coder on a cloud
116+
service (AWS, Azure, GCP) or your private data center.

‎docs/admin/README.md

-5
This file was deleted.

‎docs/admin/app-logs.md

-33
This file was deleted.

0 commit comments

Comments
 (0)