Skip to content

docs: improve dev containers documentation for user start-up #15458

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 39 commits into from
Dec 2, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
d741460
add definitions to admin/index
EdwardAngert Nov 8, 2024
3ed5c3e
init devcontainers best practice doc
EdwardAngert Nov 8, 2024
dcf901c
s/definition list/bullets
EdwardAngert Nov 8, 2024
16cce07
Merge remote-tracking branch 'origin' into bp-dev-containers
EdwardAngert Nov 12, 2024
e96b1bc
admin/index glossary section
EdwardAngert Nov 13, 2024
22e399d
when to use a dev container
EdwardAngert Nov 13, 2024
4f91cd0
Merge remote-tracking branch 'origin' into bp-dev-containers
EdwardAngert Nov 13, 2024
8e37e58
admin/index glossary; devcontainer known issues
EdwardAngert Nov 13, 2024
985233a
devcontainer lifecycle scripts
EdwardAngert Nov 13, 2024
f2c59be
devcontainers directory
EdwardAngert Nov 13, 2024
b24f615
fix typo
EdwardAngert Nov 13, 2024
4c28411
make fmt
EdwardAngert Nov 13, 2024
fc20dc3
suggestions from review
EdwardAngert Nov 20, 2024
197cfa7
add steps in tabs to add-devcontainer
EdwardAngert Nov 20, 2024
5a93ff2
fix links; list templates
EdwardAngert Nov 20, 2024
8e53735
make fmt + copy review addition
EdwardAngert Nov 20, 2024
80bf5da
fix link
EdwardAngert Nov 21, 2024
ca56186
typo fix
EdwardAngert Nov 21, 2024
1491680
copy edit devcontainer/index
EdwardAngert Nov 21, 2024
7f8b079
edit add-devcontainer
EdwardAngert Nov 22, 2024
547cfe0
Apply suggestions from code review
EdwardAngert Nov 22, 2024
d22f76f
add screenshot
EdwardAngert Nov 22, 2024
ce0d2be
make fmt; copy tweaks
EdwardAngert Nov 22, 2024
66fcca0
edit example
EdwardAngert Nov 22, 2024
de58159
link typo
EdwardAngert Nov 22, 2024
69415d4
adjust image size
EdwardAngert Nov 22, 2024
ae543de
Apply suggestions from code review
EdwardAngert Nov 25, 2024
ca0da6d
Apply suggestions from code review
EdwardAngert Nov 25, 2024
381bb73
make fmt
EdwardAngert Nov 25, 2024
ade54e9
close codeblock; edit starter template steps
EdwardAngert Nov 25, 2024
e46fc13
code review
Nov 26, 2024
9982af4
make fmt
Nov 26, 2024
182d69a
rename to dev containers
Nov 26, 2024
bf2e0fa
2-col table
EdwardAngert Nov 26, 2024
cd99937
make fmt
Nov 26, 2024
d17dbea
un-double bullet def list
Nov 26, 2024
2c3ca6d
s/devcontainer/dev container
Nov 26, 2024
c28f16d
comma typo
Nov 26, 2024
f344dff
Merge remote-tracking branch 'origin' into bp-dev-containers
Nov 27, 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
make fmt
  • Loading branch information
EdwardAngert committed Nov 25, 2024
commit 381bb7368c6fae999c3b1bd797a11a51a06e15ea
13 changes: 7 additions & 6 deletions docs/admin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ For any information not strictly contained in these sections, check out our

- A [base image](./templates/managing-templates/image-management.md) contains
OS-level packages, and utilities that the Coder workspace is built on. It
can be an [example image](https://github.com/coder/images), custom image in your registry, or
one from [Docker Hub](https://hub.docker.com/search). It is defined in each
template.
can be an [example image](https://github.com/coder/images), custom image in
your registry, or one from [Docker Hub](https://hub.docker.com/search). It
is defined in each template.
- Managed by: Externally to Coder.

- **Template**
Expand Down Expand Up @@ -52,9 +52,10 @@ For any information not strictly contained in these sections, check out our

- A
[Development Container](./templates/managing-templates/devcontainers/index.md)
is an open-source specification for defining development environments (called dev containers). It is
generally stored in VCS alongside associated source code. It can reference
an existing base image, or a custom Dockerfile that will be built on-demand.
is an open-source specification for defining development environments
(called dev containers). It is generally stored in VCS alongside associated
source code. It can reference an existing base image, or a custom Dockerfile
that will be built on-demand.
- Managed by: Dev Teams

- **Dotfiles / personalization**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -140,3 +140,4 @@ Lifecycle scripts are managed by project developers.
## Next steps

- [Dev container security and caching](./devcontainer-security-caching.md)
```
Loading