8000 docs: restructure docs by matifali · Pull Request #14421 · coder/coder · GitHub
[go: up one dir, main page]

Skip to content

docs: restructure docs #14421

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

Merged
merged 238 commits into from
Oct 5, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
238 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
8000 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
b4bc37d
typos hotfix
stirby Sep 26, 2024
d7ecab5
Merge remote-tracking branch 'origin' into rebase-restructure-new
EdwardAngert Sep 26, 2024
e977a97
chore(docs): update JetBrains gateway setup (#14807)
EdwardAngert Sep 26, 2024
cb838c8
chore(docs): removes dead navigation options (#14864)
stirby Sep 27, 2024
a35a6bf
Merge branch 'main' into restructure-new
EdwardAngert Sep 27, 2024
3171216
Fix broken links in documentation
bpmct Sep 30, 2024
9364557
fix image links in subdirs
EdwardAngert Sep 30, 2024
1b51158
fix images
EdwardAngert Sep 30, 2024
234f978
fix images
EdwardAngert Sep 30, 2024
d5bbd16
fix broken links
EdwardAngert Oct 1, 2024
119c8e3
update links
EdwardAngert Oct 1, 2024
1fa31a6
update links
EdwardAngert Oct 1, 2024
4e23e4a
Update REST API use cases link in postprocess script
matifali Oct 1, 2024
3029c98
Fix broken API use cases link in README
matifali Oct 1, 2024
cdc16f7
Update JFrog Artifactory offline deployment link
matifali Oct 1, 2024
ec769ff
fix dead links in jfrog-xray.md
matifali Oct 1, 2024
0b06eb0
Fix template links in integration guide
matifali Oct 1, 2024
9d4b80c
Update link for CI/CD pipeline management
matifali Oct 1, 2024
a5de1d5
Add Git cloning guide to documentation manifest
matifali Oct 1, 2024
8fa7bd3
Update links in Git cloning tutorial for consistency
matifali Oct 1, 2024
549f6c3
Fix broken links and improve formatting in docs
matifali Oct 1, 2024
80a03c6
Fix broken links in template tutorial docs
matifali Oct 1, 2024
ca016b3
Fix line wrapping in template tutorial doc
matifali Oct 1, 2024
855cd60
Fix broken links and spelling in FAQs doc
matifali Oct 1, 2024
a7b4da5
Fix IDE link in workspaces documentation
matifali Oct 1, 2024
c32ccf7
Fix typo in workspace access README link
matifali Oct 1, 2024
5b4ea7d
Fix broken links in getting started guide
matifali Oct 1, 2024
29346db
Update Coder install link in first template guide
matifali Oct 1, 2024
6a1700a
Update remote desktops doc to enhance clarity
matifali Oct 1, 2024
77174a8
Fix image path in remote desktops guide
matifali Oct 1, 2024
719e4e0
Fix SSH link in web IDEs documentation
matifali Oct 1, 2024
e7d7ad6
Update web IDE docs with new image paths
matifali Oct 1, 2024
4395376
Update web IDE documentation for consistency
matifali Oct 1, 2024
b2db199
Improve networking and SSH link paths in docs
matifali Oct 1, 2024
ca7e33a
Remove unnecessary next steps section link
matifali Oct 1, 2024
0b0bf85
Remove trailing newline from workspace access README
matifali Oct 1, 2024
54314f8
Fix relative links in port forwarding guide
matifali Oct 1, 2024
7b48bcc
Update configuration links in install docs
matifali Oct 1, 2024
a154e2a
Fix configuration link paths in install docs
matifali Oct 1, 2024
2279054
Update validated architecture doc links
matifali Oct 1, 2024
50c2239
fix(docs): standardize spelling for consistency
matifali Oct 1, 2024
07280de
Update links and icons in validated architectures docs
matifali Oct 1, 2024
30bbeba
adjust links
EdwardAngert Oct 1, 2024
577a56c
adjust links
EdwardAngert Oct 1, 2024
4c89c23
test sentence case for next steps
EdwardAngert Oct 1, 2024
fc8025a
change-management next steps
EdwardAngert Oct 1, 2024
6a5c72d
modules next steps
EdwardAngert Oct 1, 2024
b2f7cc5
added contributing, moved security warning to main contributing page
stirby Oct 1, 2024
cf80270
added upgrading doc under install dir
stirby Oct 1, 2024
52af89c
workspace proxies added under networking
stirby Oct 1, 2024
65f825b
added quotas
stirby Oct 1, 2024
53aba05
added HA mode
stirby Oct 1, 2024
4733484
added appearance as a subsection of setup
stirby Oct 1, 2024
4ab42ef
removed legacy screenshot
stirby Oct 1, 2024
aabd716
added telemetry to admin/setup, fixed up setup README
stirby Oct 1, 2024
098eec4
removed unused notifications icon in monitoring
stirby Oct 1, 2024
23bcb6f
changed references of admin/upgrade to install/upgrade
stirby Oct 1, 2024
478d9e3
moved git cloning guide out of folder
stirby Oct 1, 2024
c1cb6cf
removed mention of experiment in notifications
stirby Oct 1, 2024
64cf961
fixed notifications structure and experiment references
stirby Oct 2, 2024
f5fd31d
copied organizations from main
stirby Oct 2, 2024
5cc0917
copied images from organizations folder in main to images/admins/user…
stirby Oct 2, 2024
c83a36a
removed empty groups heading
stirby Oct 2, 2024
062e5fe
fixed template permissions
stirby Oct 2, 2024
e95f794
added template schedule settings, very likely broke some things
stirby Oct 2, 2024
a12aa6b
Remove duplicate dotfiles.md file
matifali Oct 2, 2024
82103b3
Add section for database encryption in docs manifest
matifali Oct 2, 2024
9de0c1d
Fix relative links in Git cloning tutorial
matifali Oct 2, 2024
fe7cf77
Remove placeholder tutorial READMEs
matifali Oct 2, 2024
63be5b3
Fix user schedule image path in workspaces.md
matifali Oct 2, 2024
07e9281
Update doc links and add Jupyter module details
matifali Oct 2, 2024
a5eccec
Fix broken links in web IDEs documentation
matifali Oct 2, 2024
1b525d8
Move reverse-proxy docs from examples to docs
matifali Oct 2, 2024
4c42089
Update cloud guide links in install README
matifali Oct 2, 2024
c44a4b0
Refactor provisioners documentation
matifali Oct 2, 2024
995d509
Add provider authentication section to docs manifest
matifali Oct 2, 2024
c7052d6
Merge branch 'main' into restructure-new
EdwardAngert Oct 2, 2024
eecaacd
Revert "Merge branch 'main' into restructure-new"
8000 matifali Oct 3, 2024
9a1e9eb
docs: rebase `restructure-new` on `main` (#14960)
matifali Oct 3, 2024
871764b
Update external auth section for premium feature
matifali Oct 3, 2024
f709b8e
Add licensing and groups documentation
matifali Oct 3, 2024
88bb9fb
Add process logging documentation for workspaces
matifali Oct 3, 2024
57fd2a9
Update VSCode settings and improve documentation
matifali Oct 3, 2024
872f87e
fixup todos
stirby Oct 3, 2024
b8f0294
Remove groups documentation files
matifali Oct 4, 2024
473d766
Fix starter templates image path in docs
stirby Oct 4, 2024
9ebdc51
Update workspace update policies documentation
stirby Oct 4, 2024
71c5c5a
remove outdated todo in install/docker
stirby Oct 4, 2024
c30652f
workspace management
stirby Oct 4, 2024
15dfe55
Add icon for workspace management in manifest.json
matifali Oct 4, 2024
9edfe90
moved all content from admin/workspaces to user guides
stirby Oct 4, 2024
168e551
Merge branch 'main' into restructure-new
stirby Oct 4, 2024
48d630c
manifest typo
stirby Oct 4, 2024
9f7cc0d
Remove old workspaces documentation
matifali Oct 4, 2024
8b44dfd
Update documentation links and remove extra lines
matifali Oct 4, 2024
f1955ef
Update architecture doc links for consistency
matifali Oct 4, 2024
32d091d
Fix scale test utility link path
matifali Oct 4, 2024
fe6e89a
Update Markdown link paths for consistency
matifali Oct 4, 2024
a723adb
Refactor group and role sync documentation
matifali Oct 4, 2024
d255d99
removed outdated user-guides files
stirby Oct 4, 2024
88790e2
Update manifest for Group Sync documentation
matifali Oct 4, 2024
27e9826
Rename `README.md` to `index.md` for documentation files
matifali Oct 4, 2024
7895f41
Add trash icon and uninstall section to docs
matifali Oct 4, 2024
6e70f51
Update networking doc with connection guidelines
matifali Oct 4, 2024
ce4c83d
resolved next steps
stirby Oct 4, 2024
bd1be08
add steps for creating a template from an existing one in the CLI
stirby Oct 4, 2024
327ed27
Add icons to documentation manifest entries
matifali Oct 4, 2024
d7d9778
cli template create hotfix
stirby Oct 4, 2024
00add4b
Merge branch 'restructure-new' of https://github.com/coder/coder into…
stirby Oct 4, 2024
83e7862
Update external auth and FAQs documentation
matifali Oct 4, 2024
739cf81
Rename "Provisioners" to "External Provisioners"
stirby Oct 4, 2024
06266a8
Merge branch 'restructure-new' of https://github.com/coder/coder into…
stirby Oct 4, 2024
cecc47a
README in root
stirby Oct 4, 2024
83a001a
Rename group-sync.md to idp-sync.md for clarity
matifali Oct 4, 2024
139122a
Add LAN icon for offline deployment docs
bpmct Oct 4, 2024
bf9e16f
fixed landing page parsing
stirby Oct 4, 2024
710bd75
Merge branch 'restructure-new' of https://github.com/coder/coder into…
stirby Oct 4, 2024
2588b8a
Add external database guide to tutorials
bpmct Oct 4, 2024
efd4294
Update API and CLI documentation index filenames
matifali Oct 4, 2024
5425ecb
Rename cli README.md to index.md
matifali Oct 4, 2024
377bc53
Simplify state arrays in docs manifest.json
matifali Oct 4, 2024
ab80c9c
Fix formatting in external-auth and idp-sync docs
matifali Oct 4, 2024
bb5ae21
returning releases
stirby Oct 4, 2024
1344df1
Merge branch 'restructure-new' of https://github.com/coder/coder into…
stirby Oct 4, 2024
205f0fd
template dependencies
stirby Oct 4, 2024
5e4229d
template dependencies typo
stirby Oct 4, 2024
2813ce1
Rename 'Group Sync' to 'IDP Sync' in docs manifest
matifali Oct 4, 2024
744c316
fixed links in workspace lifecycle
stirby Oct 4, 2024
4d0df59
Update group sync references to IDP sync
matifali Oct 4, 2024
a2a3745
user guides fixups
stirby Oct 4, 2024
a4f86cc
Merge branch 'restructure-new' of https://github.com/coder/coder into…
stirby Oct 4, 2024
f209146
links in workspace management
stirby Oct 4, 2024
ada0d0b
Correct path for security documentation link
matifali Oct 4, 2024
2a5f871
typo in jetbrains guide
stirby Oct 4, 2024
a8626c6
removed commented content from user guides
stirby Oct 4, 2024
6b7a889
Add "Open in Coder" template documentation
matifali Oct 4, 2024
ed74e56
Update line wrapping in Markdown docs
matifali Oct 4, 2024
66549ad
Capitalize "Remote Desktop" title in manifest.json
matifali Oct 4, 2024
2f31f4c
broken link in api index:
stirby Oct 4, 2024
5c03ec5
Update documentation for feature stages and availability
bpmct Oct 4, 2024
eaa36a1
Fix broken link in security advisory table
bpmct Oct 4, 2024
7d4f5cc
in-product links
stirby Oct 4, 2024
8cc45ed
Merge branch 'restructure-new' of https://github.com/coder/coder into…
stirby Oct 4, 2024
4e5a095
premium tags appended to enterprise
stirby Oct 4, 2024
9c4c5f2
audited license badges and feature stages
stirby Oct 4, 2024
829c750
3 bottom up redirs
stirby Oct 4, 2024
4057158
Add markdown link check disable and enable comments
bpmct Oct 4, 2024
28ac328
Disable markdown link check in changelog file
bpmct Oct 4, 2024
3968e47
Remove duplicate FAQs documentation
bpmct Oct 4, 2024
4c072e0
Update internal documentation links
bpmct Oct 4, 2024
339486a
Update links in templates documentation
stirby Oct 4, 2024
e066db5
Merge branch 'restructure-new' of https://github.com/coder/coder into…
stirby Oct 4, 2024
8c2b937
typo
stirby Oct 4, 2024
521ee1f
Remove markdown link check comments in changelogs
bpmct Oct 4, 2024
8aac219
broken links
stirby Oct 5, 2024
92c72be
Update links in validated architectures and IDP sync docs
bpmct Oct 5, 2024
2027385
Merge branch 'restructure-new' of https://github.com/coder/coder into…
stirby Oct 5, 2024
090fb83
Merge branch 'restructure-new' of https://github.com/coder/coder into…
stirby Oct 5, 2024
376ca61
Fix image paths in IDP sync documentation
bpmct Oct 5, 2024
91c9b55
Fix broken links in IDP sync documentation
bpmct Oct 5, 2024
688c9c1
links
stirby Oct 5, 2024
d7dbd69
Merge branch 'restructure-new' of https://github.com/coder/coder into…
stirby Oct 5, 2024
7d9c336
Fix SCIM configuration link in OIDC auth docs
bpmct Oct 5, 2024
fef12c8
1/3
stirby Oct 5, 2024
c9f6ba8
Merge branch 'restructure-new' of https://github.com/coder/coder into…
stirby Oct 5, 2024
2c172e8
proxies dead link
stirby Oct 5, 2024
1a80f57
Update paths for configuration and image links
bpmct Oct 5, 2024
477e5d9
Merge branch 'main' into restructure-new
bpmct Oct 5, 2024
abfa963
fmt
bpmct Oct 5, 2024
ee19eac
gen
bpmct Oct 5, 2024
f825b77
Remove deprecated docs and adjust manifest formatting
bpmct Oct 5, 2024
d626faa
fmt
bpmct Oct 5, 2024
6642263
fixed user-guides double icon
stirby Oct 5, 2024
ece5cc9
corrected screenshot
stirby Oct 5, 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
update links
  • Loading branch information
EdwardAngert committed Oct 1, 2024
commit 119c8e322f48071b8a383a57401cfee21c4ad082
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -626,7 +626,7 @@ 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
docs/admin/integrations/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/integrations/prometheus.md
Expand Down
10 changes: 5 additions & 5 deletions docs/admin/infrastructure/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,18 +99,18 @@ A managed PostgreSQL database, with daily backups, is recommended:
- Flexible Server For GCP: Cloud SQL for PostgreSQL

Learn more about database requirements:
[Database Health](./health-check.md#database)
[Database Health](../monitoring/health-check.md#database)

### Git Providers (Recommended)

Users will likely need to pull source code and other artifacts from a git
provider. The Coder control plane and workspaces will need network connectivity
to the git provider.

- [GitHub Enterprise](../configure.md#github-enterprise)
- [GitLab](../configure.md#gitlab-self-managed)
- [BitBucket](../configure.md#bitbucket-server)
- [Other Providers](../configure.md#external-authentication)
- [GitHub Enterprise](../../admin/external-auth.md#github-enterprise)
- [GitLab](../../admin/external-auth.md#gitlab-self-managed)
- [BitBucket](../../admin/external-auth.md#bitbucket-server)
- [Other Providers](../../admin/external-auth.md#self-managed-git-providers)

### Artifact Manager (Optional)

Expand Down
8 changes: 4 additions & 4 deletions docs/admin/infrastructure/validated-architectures/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -320,20 +320,20 @@ could affect workspace users experience once the platform is live.

### Helm Chart Configuration

1. Reference our [Helm chart values file](../../../helm/coder/values.yaml) and
1. Reference our [Helm chart values file](../../../../helm/coder/values.yaml) and
identify the required values for deployment.
1. Create a `values.yaml` and add it to your version control system.
1. Determine the necessary environment variables. Here is the
[full list of supported server environment variables](../../cli/server.md).
[full list of supported server environment variables](../../../reference/cli/server.md).
1. Follow our documented
[steps for installing Coder via Helm](../../install/kubernetes.md).
[steps for installing Coder via Helm](../../../install/kubernetes.md).

### Template configuration

1. Establish dedicated accounts for users with the _Template Administrator_
role.
1. Maintain Coder templates using
[version control](../../templates/change-management.md).
[version control](../../templates/managing-templates/change-management.md).
1. Consider implementing a GitOps workflow to automatically push new template
versions into Coder from git. For example, on Github, you can use the
[Update Coder Template](https://github.com/marketplace/actions/update-coder-template)
Expand Down
33 changes: 17 additions & 16 deletions docs/admin/monitoring/health-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The deployment health page is broken up into the following sections:
## Access URL

The Access URL section shows checks related to Coder's
[access URL](./configure.md#access-url).
[access URL](../setup.md#access-url).

Coder will periodically send a GET request to `${CODER_ACCESS_URL}/healthz` and
validate that the response is `200 OK`. The expected response body is also the
Expand All @@ -27,7 +27,7 @@ _Access URL not set_

**Problem:** no access URL has been configured.

**Solution:** configure an [access URL](./configure.md#access-url) for Coder.
**Solution:** configure an [access URL](../setup.md#access-url) for Coder.

### EACS02

Expand Down Expand Up @@ -108,8 +108,8 @@ query fails.
_Database Latency High_

**Problem:** This code is returned if the median latency is higher than the
[configured threshold](../cli/server.md#--health-check-threshold-database). This
may not be an error as such, but is an indication of a potential issue.
[configured threshold](../../reference/cli/server.md#--health-check-threshold-database).
This may not be an error as such, but is an indication of a potential issue.

**Solution:** Investigate the sizing of the configured database with regard to
Coder's current activity and usage. It may be necessary to increase the
Expand All @@ -119,19 +119,20 @@ configured threshold to a higher value (this will not address the root cause).
> [!TIP]
>
> - You can enable
> [detailed database metrics](../cli/server.md#--prometheus-collect-db-metrics)
> [detailed database metrics](../../reference/cli/server.md#--prometheus-collect-db-metrics)
> in Coder's Prometheus endpoint.
> - If you have [tracing enabled](../cli/server.md#--trace), these traces may
> also contain useful information regarding Coder's database activity.
> - If you have [tracing enabled](../../reference/cli/server.md#--trace), these
> traces may also contain useful information regarding Coder's database
> activity.

## DERP

Coder workspace agents may use
[DERP (Designated Encrypted Relay for Packets)](https://tailscale.com/blog/how-tailscale-works/#encrypted-tcp-relays-derp)
to communicate with Coder. This requires connectivity to a number of configured
[DERP servers](../cli/server.md#--derp-config-path) which are used to relay
traffic between Coder and workspace agents. Coder periodically queries the
health of its configured DERP servers and may return one or more of the
[DERP servers](../../reference/cli/server.md#--derp-config-path) which are used
to relay traffic between Coder and workspace agents. Coder periodically queries
the health of its configured DERP servers and may return one or more of the
following:

### EDERP01
Expand Down Expand Up @@ -181,9 +182,9 @@ to establish [direct connections](../networking/stun.md). Without at least one
working STUN server, direct connections may not be possible.

**Solution:** Ensure that the
[configured STUN severs](../cli/server.md#derp-server-stun-addresses) are
reachable from Coder and that UDP traffic can be sent/received on the configured
port.
[configured STUN severs](../../reference/cli/server.md#--derp-server-stun-addresses)
are reachable from Coder and that UDP traffic can be sent/received on the
configured port.

### ESTUN02

Expand Down Expand Up @@ -292,10 +293,10 @@ be built until there is at least one provisioner daemon running.
**Solution:**

If you are using
[External Provisioner Daemons](./provisioners.md#external-provisioners), ensure
[External Provisioner Daemons](../provisioners.md#external-provisioners), ensure
that they are able to successfully connect to Coder. Otherwise, ensure
[`--provisioner-daemons`](../cli/server.md#provisioner-daemons) is set to a
value greater than 0.
[`--provisioner-daemons`](../../reference/cli/server.md#--provisioner-daemons)
is set to a value greater than 0.

> Note: This may be a transient issue if you are currently in the process of
> updating your deployment.
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/networking/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ In order for clients to be able to establish direct connections:
## coder server

Workspaces connect to the coder server via the server's external address, set
via [`ACCESS_URL`](../../admin/configure.md#access-url). There must not be a NAT
via [`ACCESS_URL`](../../admin/setup.md#access-url). There must not be a NAT
between workspaces and coder server.

Users connect to the coder server's dashboard and API through its `ACCESS_URL`
Expand Down
5 changes: 3 additions & 2 deletions docs/admin/networking/port-forwarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,8 +274,9 @@ configurable by either admins or users.

## SSH

First, [configure SSH](../../user-guides/workspace-access/README.md#configure-ssh) on your local machine.
Then, use `ssh` to forward like so:
First,
[configure SSH](../../user-guides/workspace-access/README.md#configure-ssh) on
your local machine. Then, use `ssh` to forward like so:

```console
ssh -L 8080:localhost:8000 coder.myworkspace
Expand Down
18 changes: 9 additions & 9 deletions docs/admin/provisioners.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Provisioners

By default, the Coder server runs
[built-in provisioner daemons](../reference/cli/server.md#provisioner-daemons), which
execute `terraform` during workspace and template builds. However, there are
sometimes benefits to running external provisioner daemons:
[built-in provisioner daemons](../reference/cli/server.md#provisioner-daemons),
which execute `terraform` during workspace and template builds. However, there
are sometimes benefits to running external provisioner daemons:

- **Secure build environments:** Run build jobs in isolated containers,
preventing malicious templates from gaining shell access to the Coder host.
Expand Down Expand Up @@ -41,10 +41,10 @@ on the Coder server and start the provisioner with
the [Helm example](#example-running-an-external-provisioner-with-helm) below.

> Coder still supports authenticating the provisioner daemon with a
> [token](../reference/cli/tokens.md) from a user with the Template Admin or Owner role.
> This method is deprecated in favor of the PSK, which only has permission to
> access provisioner daemon APIs. We recommend migrating to the PSK as soon as
> practical.
> [token](../reference/cli/tokens.md) from a user with the Template Admin or
> Owner role. This method is deprecated in favor of the PSK, which only has
> permission to access provisioner daemon APIs. We recommend migrating to the
> PSK as soon as practical.

## Types of provisioners

Expand All @@ -57,8 +57,8 @@ organization-scoped provisioner daemons.

There are two exceptions:

- [Built-in provisioners](../reference/cli/server.md#provisioner-daemons) are always
organization-scoped.
- [Built-in provisioners](../reference/cli/server.md#provisioner-daemons) are
always organization-scoped.
- External provisioners started using a
[pre-shared key (PSK)](../reference/cli/provisioner_start.md#psk) are always
organization-scoped.
Expand Down
8 changes: 5 additions & 3 deletions docs/admin/security/audit-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,15 @@ audit trails.

Audit logs can be accessed through our REST API. You can find detailed
information about this in our
[endpoint documentation](../api/audit.md#get-audit-logs).
[endpoint documentation](../../reference/api/audit.md#get-audit-logs).

## Service Logs

Audit trails are also dispatched as service logs and can be captured and
categorized using any log management tool such as [Splunk](https://splunk.com).

Example of a [JSON formatted](../cli/server.md#--log-json) audit log entry:
Example of a [JSON formatted](../../reference/cli/server.md#--log-json) audit
log entry:

```json
{
Expand Down Expand Up @@ -112,7 +113,8 @@ Example of a [JSON formatted](../cli/server.md#--log-json) audit log entry:
}
```

Example of a [human readable](../cli/server.md#--log-human) audit log entry:
Example of a [human readable](../../reference/cli/server.md#--log-human) audit
log entry:

```console
2023-06-13 03:43:29.233 [info] coderd: audit_log ID=95f7c392-da3e-480c-a579-8909f145fbe2 Time="2023-06-13T03:43:29.230422Z" UserID=6c405053-27e3-484a-9ad7-bcb64e7bfde6 OrganizationID=00000000-0000-0000-0000-000000000000 Ip=<nil> UserAgent=<nil> ResourceType=workspace_build ResourceID=988ae133-5b73-41e3-a55e-e1e9d3ef0b66 ResourceTarget="& 5D2D quot; Action=start Diff="{}" StatusCode=200 AdditionalFields="{\"workspace_name\":\"linux-container\",\"build_number\":\"7\",\"build_reason\":\"initiator\",\"workspace_owner\":\"\"}" RequestID=9682b1b5-7b9f-4bf2-9a39-9463f8e41cd6 ResourceIcon=""
Expand Down
11 changes: 6 additions & 5 deletions docs/admin/security/secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ Often, this workflow is simply:
1. Your users write them to a persistent file after they've built their
workspace

[Template parameters](./templates/parameters.md) are a dangerous way to accept
secrets. We show parameters in cleartext around the product. Assume anyone with
view access to a workspace can also see its parameters.
[Template parameters](../templates/extending-templates/parameters.md) are a
dangerous way to accept secrets. We show parameters in cleartext around the
product. Assume anyone with view access to a workspace can also see its
parameters.

## SSH Keys

Expand All @@ -32,7 +33,7 @@ environment variable.

Users can view their public key in their account settings:

![SSH keys in account settings](./images/ssh-keys.png)
![SSH keys in account settings](../../images/ssh-keys.png)

> Note: SSH keys are never stored in Coder workspaces, and are fetched only when
> SSH is invoked. The keys are held in-memory and never written to disk.
Expand Down Expand Up @@ -104,5 +105,5 @@ store and retrieve secrets in your workspace. For example, you can use
[HashiCorp Vault](https://www.vaultproject.io/) to inject secrets into your
workspace.

Refer to our [HashiCorp Vault Integration](./integrations/vault.md) guide for
Refer to our [HashiCorp Vault Integration](../integrations/vault.md) guide for
more information on how to integrate HashiCorp Vault with Coder.
4 changes: 2 additions & 2 deletions docs/admin/templates/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ practices:

- Ensure the resource has `curl` installed (alternatively, `wget` or `busybox`)
- Ensure the resource can `curl` your Coder
[access URL](../../admin/configure.md#access-url)
[access URL](../../admin/setup.md#access-url)
- Manually connect to the resource and check the agent logs (e.g.,
`kubectl exec`, `docker exec` or AWS console)
- The Coder agent logs are typically stored in `/tmp/coder-agent.log`
Expand All @@ -31,7 +31,7 @@ practices:
`/tmp/coder-shutdown-script.log`
- This can also happen if the websockets are not being forwarded correctly when
running Coder behind a reverse proxy.
[Read our reverse-proxy docs](../../admin/configure.md#tls--reverse-proxy)
[Read our reverse-proxy docs](../../admin/setup.md#tls--reverse-proxy)

## Startup script issues

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/users/github-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ First,
GitHub will ask you for the following Coder parameters:

- **Homepage URL**: Set to your Coder deployments
[`CODER_ACCESS_URL`](../cli/server.md#--access-url) (e.g.
[`CODER_ACCESS_URL`](../../reference/cli/server.md#--access-url) (e.g.
`https://coder.domain.com`)
- **User Authorization Callback URL**: Set to `https://coder.domain.com`

Expand Down
4 changes: 2 additions & 2 deletions docs/admin/users/groups-roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ or shuts down the Coder server. To avoid this, run

In low-trust environments, we do not recommend giving users direct access to
edit templates. Instead, use
[CI/CD pipelines to update templates](../templates/change-management.md) with
proper security scans and code reviews in place.
[CI/CD pipelines to update templates](../templates/managing-templates/change-management.md)
with proper security scans and code reviews in place.

### Groups
4 changes: 2 additions & 2 deletions docs/changelogs/v2.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ ben@coder.com!
Stream Kubernetes event logs to the Coder agent logs to reveal Kuernetes-level
issues such as ResourceQuota limitations, invalid images, etc.
![Kubernetes quota](https://raw.githubusercontent.com/coder/coder/main/docs/platforms/kubernetes/coder-logstream-kube-logs-quota-exceeded.png)
- [OIDC Role Sync](https://coder.com/docs/admin/auth#group-sync-enterprise)
- [OIDC Role Sync](https://coder.com/docs/admin/users/oidc-auth.md#group-sync-enterprise)
(Enterprise): Sync roles from your OIDC provider to Coder roles (e.g.
`Template Admin`) (#8595) (@Emyrk)
- Users can convert their accounts from username/password authentication to SSO
Expand All @@ -82,7 +82,7 @@ ben@coder.com!
- CLI: Added `--var` shorthand for `--variable` in
`coder templates <create/push>` CLI (#8710) (@ammario)
- Sever logs: Added fine-grained
[filtering](https://coder.com/docs/cli/server#-l---log-filter) with
[filtering](https://coder.com/docs/reference/cli/server.md#-l---log-filter)
Regex (#8748) (@ammario)
- d3991fac2 feat(coderd): add parameter insights to template insights (#8656)
(@mafredri)
Expand Down
2 changes: 1 addition & 1 deletion docs/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ resource "coder_app" "code-server" {
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`](./admin/configure.md#access-url) is not accessible
If the [`CODER_ACCESS_URL`](./admin/setup#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
4 changes: 2 additions & 2 deletions docs/install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,5 +64,5 @@ coder login https://coder.example.com

## Next up

- [Create your first template](../templates/tutorial.md)
- [Expose your control plane to other users](../admin/configure.md)
- [Create your first template](../start/first-template.md)
- [Expose your control plane to other users](../admin/setup.md)
4 changes: 2 additions & 2 deletions docs/install/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,5 @@ coder login https://coder.example.com

## Next up

- [Create your first template](../start/first-template.md)
- [Control plane configuration](../admin/configuration.md)
- [Create your first template](../tutorials/template-from-scratch.md)
- [Control plane configuration](../admin/setup.md)
4 changes: 2 additions & 2 deletions docs/install/cloud/compute-engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,5 +74,5 @@ to set up authentication.

- [IDEs with Coder](../../user-guides/workspace-access/README.md)
- [Writing custom templates for Coder](../../admin/templates/README.md)
- [Configure the Coder server](../../admin/configure.md)
- [Use your own domain + TLS](../../admin/configure.md#tls--reverse-proxy)
- [Configure the Coder server](../../admin/setup.md)
- [Use your own domain + TLS](../../admin/setup.md#tls--reverse-proxy)
4 changes: 2 additions & 2 deletions docs/install/cloud/ec2.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,5 +86,5 @@ creating VM-based workspaces.

- [IDEs with Coder](../../user-guides/workspace-access/README.md)
- [Writing custom templates for Coder](../../admin/templates/README.md)
- [Configure the Coder server](../../admin/configure.md)
- [Use your own domain + TLS](../../admin/configure.md#tls--reverse-proxy)
- [Configure the Coder server](../../admin/setup.md)
- [Use your own domain + TLS](../../admin/setup.md#tls--reverse-proxy)
8 changes: 4 additions & 4 deletions docs/install/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,10 @@ group, the above may not work as-is.
In order to use cloud-based templates (e.g. Kubernetes, AWS), you must have an
external URL that users and workspaces will use to connect to Coder. For
proof-of-concept deployments, you can use
[Coder's tunnel](../admin/configure.md#tunnel). For production deployments, we
recommend setting an [access URL](../admin/configure.md#access-url)
[Coder's tunnel](../admin/setup.md#tunnel). For production deployments, we
recommend setting an [access URL](../admin/setup.md#access-url)

## Next steps

- [Create your first template](../start/first-template.md)
- [Control plane configuration](../admin/configure.md)
- [Create your first template](../tutorials/template-from-scratch.md)
- [Control plane configuration](../admin/setup.md#configure-control-plane-access)
6 changes: 3 additions & 3 deletions docs/install/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -287,10 +287,10 @@ Ensure you have an externally-reachable `CODER_ACCESS_URL` set in your helm
chart. If you do not have a domain set up, this should be the IP address of
Coder's LoadBalancer (`kubectl get svc -n coder`).

See [troubleshooting templates](../admin//templates/troubleshooting.md) for more
See [troubleshooting templates](../admin/templates/troubleshooting.md) for more
steps.

## Next steps

- [Create your first template](../start/first-template.md)
- [Control plane configuration](../admin/configure.md)
- [Create your first template](../tutorials/template-from-scratch.md)
- [Control plane configuration](../admin/setup.md)
4 changes: 2 additions & 2 deletions docs/install/offline.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,5 +264,5 @@ local machine has outbound HTTPS (port 443) connectivity to:

## Next steps

- [Create your first template](../start/first-template.md)
- [Control plane configuration](../admin/configuration.md)
- [Create your first template](../tutorials/template-from-scratch.md)
- [Control plane configuration](../admin/setup.md)
4 changes: 2 additions & 2 deletions docs/install/openshift.md
Original file line number Diff line number Diff line change
Expand Up @@ -325,5 +325,5 @@ This template should be ready to use straight away.

## Next steps

- [Create your first template](../start/first-template.md)
- [Control plane configuration](../admin/configuration.md)
- [Create your first template](../tutorials/template-from-scratch.md)
- [Control plane configuration](../admin/setup.md)
Loading
0