synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-13 21:36:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: unify template naming (#15757)

Browse Source 
This PR changes template names and docs to follow the
`<provider>-<os/whatever>` format for all templates.
I've decided not to split this into multiple PRs because I'd have to
edit rebase the other PRs once one of them gets merged, this should be
relatively low-impact anyways.

This aligns with our goals to make templates more user-friendly.

Closes #15754
This commit is contained in:
Phorcys
2024-12-05 18:37:25 +01:00
committed by GitHub
parent 354d0fc4c8
commit 069655ace9
15 changed files with 31 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/admin/templates/extending-templates/docker-in-workspaces.md
View File

@ -148,7 +148,7 @@ nodes. Refer to sysbox's
to ensure your nodes are compliant.
To get started with `envbox` check out the
[starter template](https://github.com/coder/coder/tree/main/examples/templates/envbox)
[starter template](https://github.com/coder/coder/tree/main/examples/templates/kubernetes-envbox)
or visit the [repo](https://github.com/coder/envbox).
### Authenticating with a Private Registry

8
docs/admin/templates/managing-templates/devcontainers/add-devcontainer.md
View File

@ -38,7 +38,7 @@ choose a template from the
1. Use the `template init` command to initialize your choice of image:
```shell
coder template init --id devcontainer-kubernetes
coder template init --id kubernetes-devcontainer
```
A list of available templates is shown in the
@ -47,7 +47,7 @@ choose a template from the
1. `cd` into the directory and push the template to your Coder deployment:
```shell
cd devcontainer-kubernetes && coder templates push
cd kubernetes-devcontainer && coder templates push
```
You can also edit the files or make changes to the files before you push them
@ -122,8 +122,8 @@ their development environments:
| Template | Description |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Docker dev containers](https://github.com/coder/coder/tree/main/examples/templates/devcontainer-docker) | Docker provisions a development container. |
| [Kubernetes dev containers](https://github.com/coder/coder/tree/main/examples/templates/devcontainer-kubernetes) | Provisions a development container on the Kubernetes cluster. |
| [Docker dev containers](https://github.com/coder/coder/tree/main/examples/templates/docker-devcontainer) | Docker provisions a development container. |
| [Kubernetes dev containers](https://github.com/coder/coder/tree/main/examples/templates/kubernetes-devcontainer) | Provisions a development container on the Kubernetes cluster. |
| [Google Compute Engine dev container](https://github.com/coder/coder/tree/main/examples/templates/gcp-devcontainer) | Runs a development container inside a single GCP instance. It also mounts the Docker socket from the VM inside the container to enable Docker inside the workspace. |
| [AWS EC2 dev container](https://github.com/coder/coder/tree/main/examples/templates/aws-devcontainer) | Runs a development container inside a single EC2 instance. It also mounts the Docker socket from the VM inside the container to enable Docker inside the workspace. |