Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

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

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions.gitattributes
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
# Generated files
coderd/apidoc/docs.go linguist-generated=true
docs/api/*.md linguist-generated=true
docs/cli/*.md linguist-generated=true
docs/reference/api/*.md linguist-generated=true
docs/reference/cli/*.md linguist-generated=true
coderd/apidoc/swagger.json linguist-generated=true
coderd/database/dump.sql linguist-generated=true
peerbroker/proto/*.go linguist-generated=true
Expand Down
1 change: 1 addition & 0 deletions.github/workflows/typos.toml
View file
Open in desktop
Original file line numberDiff line numberDiff 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
4 changes: 2 additions & 2 deletions.prettierrc.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,8 +9,8 @@ tabWidth: 2
overrides:
- files:
- README.md
- docs/api/**/*.md
- docs/cli/**/*.md
- docs/reference/api/**/*.md
- docs/reference/cli/**/*.md
- docs/changelogs/*.md
- .github/**/*.{yaml,yml,toml}
- scripts/**/*.{yaml,yml,toml}
Expand Down
2 changes: 1 addition & 1 deletion.vscode/settings.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -196,7 +196,7 @@
"**/*.gen.json": true,
"**/testdata/*": true,
"coderd/apidoc/**": true,
"docs/api/*.md": true,
"docs/reference/api/*.md": true,
"docs/templates/*.md": true,
"LICENSE": true,
"scripts/metricsdocgen/metrics": true,
Expand Down
30 changes: 13 additions & 17 deletionsMakefile
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -488,9 +488,9 @@ gen: \
coderd/rbac/object_gen.go \
codersdk/rbacresources_gen.go \
site/src/api/rbacresources_gen.ts \
docs/admin/prometheus.md \
docs/cli.md \
docs/admin/audit-logs.md \
docs/admin/integrations/prometheus.md \
docs/reference/cli/README.md \
docs/admin/security/audit-logs.md \
coderd/apidoc/swagger.json \
.prettierignore.include \
.prettierignore \
Expand DownExpand Up@@ -520,9 +520,9 @@ gen/mark-fresh:
coderd/rbac/object_gen.go \
codersdk/rbacresources_gen.go \
site/src/api/rbacresources_gen.ts \
docs/admin/prometheus.md \
docs/cli.md \
docs/admin/audit-logs.md \
docs/admin/integrations/prometheus.md \
docs/reference/cli/README.md \
docs/admin/security/audit-logs.md \
coderd/apidoc/swagger.json \
.prettierignore.include \
.prettierignore \
Expand DownExpand Up@@ -624,29 +624,25 @@ coderd/rbac/object_gen.go: scripts/rbacgen/rbacobject.gotmpl scripts/rbacgen/mai
codersdk/rbacresources_gen.go: scripts/rbacgen/codersdk.gotmpl scripts/rbacgen/main.go coderd/rbac/object.go coderd/rbac/policy/policy.go
go run scripts/rbacgen/main.go codersdk > codersdk/rbacresources_gen.go

site/src/api/rbacresources_gen.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 > site/src/api/rbacresources_gen.ts


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/prometheus.md
pnpm exec prettier --write ./docs/admin/integrations/prometheus.md

docs/cli.md: scripts/clidocgen/main.go examples/examples.gen.json $(GO_SRC_FILES)
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/cli.md ./docs/cli/*.md ./docs/manifest.json
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
./scripts/pnpm_install.sh
pnpm exec prettier --write ./docs/api ./docs/manifest.json ./coderd/apidoc/swagger.json
pnpm exec prettier --write ./docs/reference/api ./docs/manifest.json ./coderd/apidoc/swagger.json

update-golden-files: \
cli/testdata/.gen-golden \
Expand Down
12 changes: 10 additions & 2 deletionsdocs/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
# About Coder
# Coder Docs Landing

TODO: Make this a landing page with links to relevant docs, see

- [Docker](https://docs.docker.com/)
- [Vercel](https://vercel.com/docs)
-

<!-- # About Coder

Coder is an open-source platform for creating and managing developer workspaces
on your preferred clouds and servers.
Expand DownExpand Up@@ -105,4 +113,4 @@ Azure, Google Cloud, Kubernetes, and more.
## Up next

- Learn about [Templates](./templates/index.md)
- [Install Coder](./install/index.md#install-coder)
- [Install Coder](./install/index.md#install-coder) -->
43 changes: 39 additions & 4 deletionsdocs/admin/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,40 @@
Get started with Coder administration:
# Administration

<children>
This page is rendered on https://coder.com/docs/coder-oss/admin. Refer to the other documents in the `admin/` directory.
</children>
Guides for day 2+ operations with Coder, including preparing for production and scaling to thousands of daily active users.

## Prerequisites

## Table of contents

- Infrastructure & Scale
- Kubernetes Best Practices
- Reference Architectures (up to 3000 users)
- VM Best Practices
- Optimize networking & latency
- Add workspace regions
- Add Kubernetes clusters
- Scale testing your Coder deployment
- User Management
- Set up OpenID Connect (SSO)
- Configure Group & Role Sync
- Configure Template Permissions
- Workspace Management
- Keep workspaces up to date
- Clean up unused workspaces
- Template & Image Management
- Building golden images
- Add Dev Container support (custom dependencies)
- Manage templates with Ci/Cd pipelines
- Security
- Auditing Coder users
- Managing cloud secrets
- Manage workspace secrets
- Security flags
- Monitoring
- Configure server logging
- Troubleshooting Templates
- Monitoring via Prometheus / Grafana
- Analytics
- Measure user adoption (weekly active users)
- Identifying Coder power users
- Reading template usage metrics
33 changes: 0 additions & 33 deletionsdocs/admin/app-logs.md
View file
Open in desktop

This file was deleted.

99 changes: 0 additions & 99 deletionsdocs/admin/appearance.md
View file
Open in desktop

This file was deleted.

Loading
[8]ページ先頭
©2009-2025 Movatter.jp