8000 ap title case · coder/coder@8f5e613 · GitHub
[go: up one dir, main page]
Skip to content

Commit 8f5e613

Browse files
EdwardAngertEdwardAngert
committed
ap title case
1 parent 88e7c0f commit 8f5e613

File tree

7 files changed

+32
-32
lines changed

7 files changed

+32
-32
lines changed

‎docs/admin/templates/extending-templates/advanced-dev-containers.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Advanced dev container configuration
1+
# Advanced Dev Container Configuration
22

33
This page extends [devcontainers.md](./devcontainers.md) with patterns for multiple dev containers,
44
user-controlled startup, repository selection, and infrastructure tuning.
55

6-
## Run multiple dev containers
6+
## Run Multiple Dev Containers
77

88
Run independent dev containers in the same workspace so each component appears as its own agent.
99

@@ -67,7 +67,7 @@ resource "coder_devcontainer" "database" {
6767
Each dev container appears as a separate agent, so developers can connect to any
6868
component in the workspace.
6969

70-
## Personal overrides
70+
## Personal Overrides
7171

7272
Let developers extend the repo’s `devcontainer.json` with an ignored (by Git) `devcontainer.local.json` file
7373
so they can add personal tools without changing the canonical configuration:
@@ -85,7 +85,7 @@ so they can add personal tools without changing the canonical configuration:
8585
Add the file name to your project's `.gitignore` or the user's
8686
[global exclude file](https://docs.github.com/en/get-started/git-basics/ignoring-files#configuring-ignored-files-for-all-repositories-on-your-computer).
8787

88-
## Conditional startup
88+
## Conditional Startup
8989

9090
Use `coder_parameter` booleans to let workspace creators choose which dev containers start automatically,
9191
reducing resource usage for unneeded components:
@@ -107,7 +107,7 @@ resource "coder_devcontainer" "frontend" {
107107
}
108108
```
109109

110-
## Repository-selection patterns
110+
## Repository-selection Patterns
111111

112112
Prompt users to pick a repository or team at workspace creation time and clone the selected repo(s) automatically into the workspace:
113113

@@ -167,7 +167,7 @@ module "git_clone_team" {
167167
}
168168
```
169169

170-
## Infrastructure tuning
170+
## Infrastructure Tuning
171171

172172
Adjust workspace infrastructure to set memory/CPU limits, attach a custom Docker network,
173173
or add persistent volumes—to improve performance and isolation for dev containers:
@@ -215,7 +215,7 @@ resource "docker_container" "workspace" {
215215
}
216216
```
217217

218-
## Troubleshooting tips
218+
## Troubleshooting
219219

220220
1. Run `docker ps` inside the workspace to ensure Docker is available.
221221
1. Check `/tmp/startup.log` for agent logs.

‎docs/admin/templates/extending-templates/dev-containers-envbuilder.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Choose an approach to Dev Containers
1+
# Choose an Approach To Dev Containers
22

33
Coder supports two independent ways to run Dev Containers inside a workspace.
44

@@ -7,7 +7,7 @@ who controls it, and which runtime requirements exist.
77

88
Use this page to decide which path fits your project or platform needs.
99

10-
## Options at a glance
10+
## Options at a Glance
1111

1212
| Capability / Trait | Dev Containers integration (CLI-based) | Envbuilder Dev Containers |
1313
|------------------------------------------|------------------------------------------|-------------------------------------------|
@@ -20,7 +20,7 @@ Use this page to decide which path fits your project or platform needs.
2020
| Templates | Standard `devcontainer.json` | Terraform + Envbuilder blocks |
2121
| Suitable for CI / AI agents | Yes. Deterministic, composable | Less ideal. No isolated container |
2222

23-
## When to choose the Dev Containers integration
23+
## When To Choose the Dev Containers Integration
2424

2525
Choose the new integration if:
2626

@@ -31,7 +31,7 @@ Choose the new integration if:
3131

3232
[Dev Container integration](./devcontainers.md) documentation.
3333

34-
## When to choose Envbuilder
34+
## When To Choose Envbuilder
3535

3636
Envbuilder remains a solid choice when:
3737

@@ -42,7 +42,7 @@ Envbuilder remains a solid choice when:
4242

4343
[Envbuilder Dev Container](../managing-templates/devcontainers/add-devcontainer.md#envbuilder-terraform-provider) documentation.
4444

45-
## How to migrate from Envbuilder to the Dev Containers integration
45+
## How To Migrate From Envbuilder to the Dev Containers Integration
4646

4747
1. Ensure the workspace image can run Docker and has sufficient resources:
4848

@@ -65,7 +65,7 @@ Envbuilder remains a solid choice when:
6565
Coder detects and launches the dev container automatically.
6666
1. Verify ports, SSH, and rebuild prompts function as expected.
6767

68-
## Related reading
68+
## Related Reading
6969

7070
- [Dev Containers Integration](./index.md)
7171
- [Troubleshooting Dev Containers](../../../user-guides/devcontainers/troubleshooting-dev-containers.md)

‎docs/admin/templates/extending-templates/devcontainers.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Configure a template for dev containers
1+
# Configure a Template for Dev Containers
22

33
Dev containers provide a consistent, reproducible development environment using the
44
[Development Containers specification](https://containers.dev/).
@@ -7,7 +7,7 @@ Coder's dev container support allows developers to work in fully configured envi
77
To enable dev containers in workspaces, [configure your template](../creating-templates.md) with the dev containers
88
modules and configurations outlined in this doc.
99

10-
## Why use dev containers
10+
## Why Use Dev Containers
1111

1212
Dev containers improve consistency across environments by letting developers define their development setup.
1313
When integrated with Coder templates, they provide:
@@ -72,7 +72,7 @@ Alternatively, install the devcontainer CLI manually in your base image:
7272
RUN npm install -g @devcontainers/cli
7373
```
7474

75-
## Define the dev container resource
75+
## Define the Dev Container Resource
7676

7777
If you don't use [`git_clone`](#clone-the-repository), point the resource at the folder that contains `devcontainer.json`:
7878

@@ -84,7 +84,7 @@ resource "coder_devcontainer" "project" {
8484
}
8585
```
8686

87-
## Clone the repository
87+
## Clone the Repository
8888

8989
This step is optional, but it ensures that the project is present before the dev container starts.
9090

@@ -108,7 +108,7 @@ resource "coder_devcontainer" "project" {
108108
}
109109
```
110110

111-
## Dev container features
111+
## Dev Container Features
112112

113113
Enhance your dev container experience with additional features.
114114
For more advanced use cases, consult the [advanced dev containers doc](./advanced-dev-containers.md).
@@ -282,9 +282,9 @@ resource "kubernetes_pod" "workspace" {
282282

283283
</details>
284284

285-
## Troubleshoot common issues
285+
## Troubleshoot Common Issues
286286

287-
### Disable Dev Containers Integration
287+
### Disable dev containers integration
288288

289289
To disable the dev containers integration in your workspace, add the `CODER_AGENT_DEVCONTAINERS_ENABLE` environment variable to your existing `coder_agent` block:
290290

‎docs/admin/templates/managing-templates/devcontainers/add-devcontainer.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Add an Envbuilder dev container template
1+
# Add an Envbuilder Dev Container Template
22

33
This guide shows platform administrators how to add an Envbuilder dev container template to Coder.
44

@@ -118,7 +118,7 @@ their development environments:
118118
# …
119119
```
120120

121-
## Example templates
121+
## Example Templates
122122

123123
| Template | Description |
124124
|---------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -132,7 +132,7 @@ Your template can prompt the user for a repo URL with
132132

133133
![Dev container parameter screen](../../../../images/templates/devcontainers.png)
134134

135-
## Dev container lifecycle scripts
135+
## Dev Container Lifecycle Scripts
136136

137137
The `onCreateCommand`, `updateContentCommand`, `postCreateCommand`, and
138138
`postStartCommand` lifecycle scripts are run each time the container is started.
@@ -141,7 +141,7 @@ a user begins using the workspace.
141141

142142
Lifecycle scripts are managed by project developers.
143143

144-
## Next steps
144+
## Next Steps
145145

146146
- [Choose an approach to Dev Containers](../../extending-templates/dev-containers-envbuilder.md)
147147
- [Dev container security and caching](./devcontainer-security-caching.md)

‎docs/admin/templates/managing-templates/devcontainers/devcontainer-releases-known-issues.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Envbuilder dev container releases and known issues
1+
# Envbuilder Dev Container Releases and Known Issues
22

3-
## Release channels
3+
## Release Channels
44

55
Envbuilder provides two release channels:
66

@@ -18,7 +18,7 @@ Refer to the
1818
[Envbuilder GitHub repository](https://github.com/coder/envbuilder/) for more
1919
information and to submit feature requests or bug reports.
2020

21-
## Known issues
21+
## Known Issues
2222

2323
Visit the
2424
[Envbuilder repository](https://github.com/coder/envbuilder/blob/main/docs/devcontainer-spec-support.md)

‎docs/admin/templates/managing-templates/devcontainers/devcontainer-security-caching.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# Envbuilder dev container security and caching
1+
# Envbuilder Dev Container Security and Caching
22

33
Envbuilder can pull only pre-approved images and artifacts when you configure it with your enterprise proxies,
44
firewalls, and artifact managers.
55

6-
## Configure registry authentication
6+
## Configure Registry Authentication
77

88
You may need to authenticate to your container registry, such as Artifactory, or
99
Git provider such as GitLab, to use Envbuilder. See the
1010
[Envbuilder documentation](https://github.com/coder/envbuilder/blob/main/docs/container-registry-auth.md)
1111
for more information.
1212

13-
## Layer and image caching
13+
## Layer and Image Caching
1414

1515
To improve build times, dev containers can be cached. There are two main forms
1616
of caching:
@@ -60,7 +60,7 @@ If you are building your own Dev container template, you can consult the
6060
You may also wish to consult a
6161
[documented example usage of the `envbuilder_cached_image` resource](https://github.com/coder/terraform-provider-envbuilder/blob/main/examples/resources/envbuilder_cached_image/envbuilder_cached_image_resource.tf).
6262

63-
## Next steps
63+
## Next Steps
6464

6565
- [Dev container releases and known issues](./devcontainer-releases-known-issues.md)
6666
- [Dotfiles](../../../../user-guides/workspace-dotfiles.md)

‎docs/admin/templates/managing-templates/devcontainers/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ open-source project. This means that Envbuilder can be used with Coder, but it
5959
is not required. It also means that dev container builds can scale independently
6060
of the Coder control plane and even run within a CI/CD pipeline.
6161

62-
## Next steps
62+
## Next Steps
6363

6464
- [Add an Envbuilder dev container template](./add-devcontainer.md)
6565
- [Choose an approach to Dev Containers](../../extending-templates/dev-containers-envbuilder.md)

0 commit comments

Comments
 (0)
0