Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 069655a

Browse files
phorcys420phorcys420
authored
chore: unify template naming (#15757)
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
1 parent 354d0fc commit 069655a

File tree

15 files changed

+31
-31
lines changed

15 files changed

+31
-31
lines changed

‎cli/testdata/coder_templates_init_--help.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ USAGE:
66
Get started with a templated template.
77

88
OPTIONS:
9-
--id aws-devcontainer|aws-linux|aws-windows|azure-linux|devcontainer-docker|devcontainer-kubernetes|do-linux|docker|gcp-devcontainer|gcp-linux|gcp-vm-container|gcp-windows|kubernetes|nomad-docker|scratch
9+
--id aws-devcontainer|aws-linux|aws-windows|azure-linux|digitalocean-linux|docker|docker-devcontainer|gcp-devcontainer|gcp-linux|gcp-vm-container|gcp-windows|kubernetes|kubernetes-devcontainer|nomad-docker|scratch
1010
Specify a given example template by ID.
1111

1212
———

‎docs/admin/templates/extending-templates/docker-in-workspaces.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ nodes. Refer to sysbox's
148148
to ensure your nodes are compliant.
149149

150150
To get started with `envbox` check out the
151-
[starter template](https://github.com/coder/coder/tree/main/examples/templates/envbox)
151+
[starter template](https://github.com/coder/coder/tree/main/examples/templates/kubernetes-envbox)
152152
or visit the [repo](https://github.com/coder/envbox).
153153

154154
### Authenticating with a Private Registry

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ choose a template from the
3838
1. Use the `template init` command to initialize your choice of image:
3939

4040
```shell
41-
coder template init --id devcontainer-kubernetes
41+
coder template init --id kubernetes-devcontainer
4242
```
4343

4444
A list of available templates is shown in the
@@ -47,7 +47,7 @@ choose a template from the
4747
1. `cd` into the directory and push the template to your Coder deployment:
4848

4949
```shell
50-
cd devcontainer-kubernetes && coder templates push
50+
cd kubernetes-devcontainer && coder templates push
5151
```
5252

5353
You can also edit the files or make changes to the files before you push them
@@ -122,8 +122,8 @@ their development environments:
122122

123123
| Template | Description |
124124
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
125-
| [Docker dev containers](https://github.com/coder/coder/tree/main/examples/templates/devcontainer-docker) | Docker provisions a development container. |
126-
| [Kubernetes dev containers](https://github.com/coder/coder/tree/main/examples/templates/devcontainer-kubernetes) | Provisions a development container on the Kubernetes cluster. |
125+
| [Docker dev containers](https://github.com/coder/coder/tree/main/examples/templates/docker-devcontainer) | Docker provisions a development container. |
126+
| [Kubernetes dev containers](https://github.com/coder/coder/tree/main/examples/templates/kubernetes-devcontainer) | Provisions a development container on the Kubernetes cluster. |
127127
| [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. |
128128
| [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. |
129129

‎docs/reference/cli/templates_init.md

+3-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)