Skip to content

chore: unify template naming #15757

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.

Sign up for GitHub

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 6 commits into from
Dec 5, 2024
Merged

chore: unify template naming #15757

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
38aeaa5
chore: rename `devcontainer-docker` template to `docker-devcontainer`
phorcys420 Dec 4, 2024
ebf63e7
chore: rename `devcontainer-kubernetes` template to `kubernetes-devco…
phorcys420 Dec 4, 2024
da67150
chore: rename `envbox` template to `kubernetes-envbox`
phorcys420 Dec 4, 2024
68429e5
chore: rename `do-linux` template to `digitalocean-linux`
phorcys420 Dec 4, 2024
a736823
chore: run `make gen` and `make fmt`
phorcys420 Dec 5, 2024
71860a3
chore: run `make update-golden-files`
phorcys420 Dec 5, 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
2 changes: 1 addition & 1 deletion cli/testdata/coder_templates_init_--help.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ USAGE:
Get started with a templated template.

OPTIONS:
--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
--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
Specify a given example template by ID.

———
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/templates/extending-templates/docker-in-workspaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/admin/templates/managing-templates/devcontainers/add-devcontainer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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. |

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/cli/templates_init.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading