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

Skip to content

docs: restructure docs #14

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

Open
wants to merge 64 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
64 commits
Select commit Hold shift + click to select a range
3479450
rebase
matifali Aug 23, 2024
6a4dce4
fmt
matifali Aug 23, 2024
df70a5a
fix: set network telemetry client version on server (#14376)
ethanndickson Aug 23, 2024
5ccd232
make gen
matifali Aug 23, 2024
c3728ba
update tutorials paths
matifali Aug 23, 2024
700b51a
Merge branch 'main' into restructure-new
matifali Aug 23, 2024
d65f67d
Merge branch 'main' into restructure-new
matifali Aug 24, 2024
aaeb82c
gen
matifali Aug 24, 2024
a3bf62b
fix a typo check
matifali Aug 24, 2024
43b97f6
add automation page and fiox links in workspace page
matifali Aug 26, 2024
72a522e
fmt & gen
matifali Aug 26, 2024
a099dc8
fix misc links
matifali Aug 26, 2024
4059f9f
Merge branch 'main' into restructure-new
matifali Aug 28, 2024
cf5bc72
Merge branch 'main' into restructure-new
matifali Aug 30, 2024
0903742
Merge branch 'main' into restructure-new
matifali Sep 1, 2024
c466c9f
Merge branch 'main' into restructure-new
matifali Sep 3, 2024
ce62ff2
Merge branch 'main' into restructure-new
matifali Sep 3, 2024
31c8df0
spellings
matifali Sep 3, 2024
422e10b
clean up and fix some links
matifali Sep 3, 2024
5631239
port #14548
ethanndickson Sep 5, 2024
a4d5201
link troubleshooting
ethanndickson Sep 5, 2024
fd55137
add TODOs
matifali Sep 5, 2024
99d2c8a
more TODO
matifali Sep 5, 2024
2368272
Update manifest.json to match formatting
bpmct Sep 5, 2024
09068b7
Update administration documentation
bpmct Sep 5, 2024
4fca737
link control plane configuraion in install docs
matifali Sep 5, 2024
f8cbcf7
Update links to git provider configuration
bpmct Sep 5, 2024
bd0f0a5
Rename "Workspaces" to "User Guides"
bpmct Sep 5, 2024
39ad5fc
Fix broken link to provisioner authentication in docs
bpmct Sep 5, 2024
8e8b9bc
add docker in workspaces
matifali Sep 5, 2024
9406258
port #14567
matifali Sep 5, 2024
d72574b
move workspace-tags
matifali Sep 5, 2024
82748cf
chore: update installation landing page (#14574)
stirby Sep 5, 2024
53c7eb3
`make fmt`
matifali Sep 5, 2024
f384947
Add icons to various documentation sections
matifali Sep 5, 2024
2c96f63
add icons
matifali Sep 5, 2024
9dabe14
Update icon paths in manifest.json
matifali Sep 6, 2024
2ebdf95
Add terms to VSCode settings for spell checking
matifali Sep 6, 2024
413ec60
Refactor external authentication docs
matifali Sep 6, 2024
5ee9074
Move notifications to monitoring
stirby Sep 10, 2024
b033598
fixed notifications link to feature stages
stirby Sep 10, 2024
a79dabd
Fix duplicate "About" entry in docs manifest
matifali Sep 10, 2024
257d3bc
Refactor docs to improve initial user engagement
matifali Sep 10, 2024
ad11fa4
Rename "Control Plane" to "Setup" in docs
matifali Sep 10, 2024
6016996
Refactor automation documentation
matifali Sep 10, 2024
dd7c93d
Rename `configure.md` to `setup.md`
matifali Sep 10, 2024
94a50d8
Update link to external authentication doc
matifali Sep 10, 2024
5c3c383
Add metrics documentation for Prometheus
stirby Sep 10, 2024
f9b8053
Merge branch 'restructure-new' of https://github.com/coder/coder into…
stirby Sep 10, 2024
256a0d8
Add icons for Access Workspaces and Scheduling sections
matifali Sep 10, 2024
b422368
docs: add introduction to user guides
stirby Sep 10, 2024
b6c4935
Fix formatting issues in docs
matifali Sep 10, 2024
f1e15ad
make fmt
stirby Sep 10, 2024
4cefd99
merge
stirby Sep 10, 2024
aa35197
Update admin README with setup and references
stirby Sep 10, 2024
44f0f5c
Update workspace lifecycle docs with new links
matifali Sep 12, 2024
9295103
Add puzzle icon for integrations section
matifali Sep 17, 2024
e9230db
chore: rename docs title from About to Home
matifali Sep 17, 2024
470b917
refactor: clean up and restructure docs links
matifali Sep 17, 2024
60012b0
chore(docs): add security advisories section
stirby Sep 17, 2024
d58b699
Update Terraform code blocks to use `tf` language
matifali Sep 17, 2024
7a55e4c
fix: update SCIM API key environment variable name
stirby Sep 17, 2024
e3e5bab
Merge branch 'restructure-new' of https://github.com/coder/coder into…
stirby Sep 17, 2024
2be7a15
docs: fix line wrapping for dotfiles module section
stirby Sep 17, 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
1 change: 1 addition & 0 deletions .github/workflows/typos.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ pn = "pn"
EDE = "EDE"
# HELO is an SMTP command
HELO = "HELO"
LKE = "LKE"

[files]
extend-exclude = [
Expand Down
19 changes: 17 additions & 2 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"ASKPASS",
"authcheck",
"autostop",
"autoupdate",
"awsidentity",
"bodyclose",
"buildinfo",
Expand All @@ -14,22 +15,27 @@
"cliflag",
"cliui",
"codecov",
"codercom",
"coderd",
"coderdenttest",
"coderdtest",
"codersdk",
"contravariance",
"cronstrue",
"databasefake",
"dbcrypt",
"dbgen",
"dbmem",
"dbtype",
"DERP",
"derphttp",
"derpmap",
"devcontainers",
"devel",
"devtunnel",
"dflags",
"dogfood",
"dotfiles",
"drpc",
"drpcconn",
"drpcmux",
Expand All @@ -43,6 +49,7 @@
"externalauth",
"Failf",
"fatih",
"filebrowser",
"Formik",
"gitauth",
"gitsshkey",
Expand All @@ -63,9 +70,11 @@
"initialisms",
"ipnstate",
"isatty",
"jetbrains",
"Jobf",
"Keygen",
"kirsle",
"knowledgebase",
"Kubernetes",
"ldflags",
"magicsock",
Expand All @@ -77,6 +86,7 @@
"namesgenerator",
"namespacing",
"netaddr",
"netcheck",
"netip",
"netmap",
"netns",
Expand All @@ -93,13 +103,15 @@
"opty",
"paralleltest",
"parameterscopeid",
"portsharing",
"pqtype",
"prometheusmetrics",
"promhttp",
"protobuf",
"provisionerd",
"provisionerdserver",
"provisionersdk",
"ptrace",
"ptty",
"ptys",
"ptytest",
Expand All @@ -114,6 +126,7 @@
"Signup",
"slogtest",
"sourcemapped",
"speedtest",
"spinbutton",
"Srcs",
"stdbuf",
Expand Down Expand Up @@ -153,9 +166,10 @@
"turnconn",
"typegen",
"typesafe",
"unauthenticate",
"unconvert",
"Untar",
"Userspace",
"untar",
"userspace",
"VMID",
"walkthrough",
"weblinks",
Expand All @@ -171,6 +185,7 @@
"workspaceapps",
"workspacebuilds",
"workspacename",
"workspaceproxies",
"wsjson",
"xerrors",
"xlarge",
Expand Down
15 changes: 7 additions & 8 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -492,9 +492,9 @@ gen: \
coderd/rbac/object_gen.go \
codersdk/rbacresources_gen.go \
site/src/api/rbacresourcesGenerated.ts \
docs/admin/prometheus.md \
docs/admin/integrations/prometheus.md \
docs/reference/cli/README.md \
docs/admin/audit-logs.md \
docs/admin/security/audit-logs.md \
coderd/apidoc/swagger.json \
.prettierignore.include \
.prettierignore \
Expand All @@ -521,9 +521,9 @@ gen/mark-fresh:
coderd/rbac/object_gen.go \
codersdk/rbacresources_gen.go \
site/src/api/rbacresourcesGenerated.ts \
docs/admin/prometheus.md \
docs/admin/integrations/prometheus.md \
docs/reference/cli/README.md \
docs/admin/audit-logs.md \
docs/admin/security/audit-logs.md \
coderd/apidoc/swagger.json \
.prettierignore.include \
.prettierignore \
Expand Down Expand Up @@ -624,21 +624,20 @@ codersdk/rbacresources_gen.go: scripts/rbacgen/codersdk.gotmpl scripts/rbacgen/m
site/src/api/rbacresourcesGenerated.ts: scripts/rbacgen/codersdk.gotmpl scripts/rbacgen/main.go coderd/rbac/object.go coderd/rbac/policy/policy.go
go run scripts/rbacgen/main.go typescript > "$@"


docs/admin/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/metrics
go run scripts/metricsdocgen/main.go
./scripts/pnpm_install.sh
pnpm exec prettier --write ./docs/admin/prometheus.md
pnpm exec prettier --write ./docs/admin/integrations/prometheus.md

docs/reference/cli/README.md: scripts/clidocgen/main.go examples/examples.gen.json $(GO_SRC_FILES)
CI=true BASE_PATH="." go run ./scripts/clidocgen
./scripts/pnpm_install.sh
pnpm exec prettier --write ./docs/reference/cli/README.md ./docs/reference/cli/*.md ./docs/manifest.json

docs/admin/audit-logs.md: coderd/database/querier.go scripts/auditdocgen/main.go enterprise/audit/table.go coderd/rbac/object_gen.go
docs/admin/security/audit-logs.md: coderd/database/querier.go scripts/auditdocgen/main.go enterprise/audit/table.go coderd/rbac/object_gen.go
go run scripts/auditdocgen/main.go
./scripts/pnpm_install.sh
pnpm exec prettier --write ./docs/admin/audit-logs.md
pnpm exec prettier --write ./docs/admin/security/audit-logs.md

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
./scripts/apidocgen/generate.sh
Expand Down
12 changes: 6 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ By building on top of common development interfaces (SSH) and infrastructure too
## How it works

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

<p align="center">
Expand All @@ -28,11 +28,11 @@ product.
Coder workspaces don't stop at compute. You can add storage buckets, secrets, sidecars
and whatever else Terraform lets you dream up.

[Learn more about managing infrastructure.](./templates/index.md)
[Learn more about templates.](./admin/templates/README.md)

## IDE Support

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/).
You can use any [Web IDE](./admin/templates/extending-templates/web-ides.md) ([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/).

<p align="center">
<img src="./images/ide-icons.svg" height=72>
Expand Down Expand Up @@ -80,7 +80,7 @@ layer of infrastructure control. This additional layer allows admins to:
- Enable persistent workspaces, which are like local machines, but faster and
hosted by a cloud service

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

## What Coder is _not_
Expand All @@ -104,5 +104,5 @@ Azure, Google Cloud, Kubernetes, and more.

## Up next

- Learn about [Templates](./templates/index.md)
- [Install Coder](./install/index.md#install-coder)
- Learn about [Templates](./admin/templates/README.md)
- [Install Coder](./install/README.md)
14 changes: 10 additions & 4 deletions docs/admin/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
Get started with Coder administration:
# Administration

<children>
This page is rendered on https://coder.com/docs/admin. Refer to the other documents in the `admin/` directory.
</children>
These guides contain information on managing the Coder control plane and [authoring templates](./templates/README.md).

First time viewers looking to set up control plane access can start with the [configuration guide](./setup.md). If you're a team lead looking to design environments for your developers, check out our [templates guides](./templates/README.md). If you are a developer using Coder, we recommend the [user guides](../user-guides/README.md).

For automation and scripting workflows, see our [CLI](../reference/cli/README.md) and [API](../reference/api/README.md) docs.

For any information not strictly contained in these sections, check out our [Tutorials](../tutorials/README.md) and [FAQs](../tutorials/faqs.md).

<children></children>
33 changes: 0 additions & 33 deletions docs/admin/app-logs.md

This file was deleted.

99 changes: 0 additions & 99 deletions docs/admin/appearance.md

This file was deleted.

Loading