Skip to content

Commit 2e86b76

Browse files
bpmctkylecarbsmatifali
authored
docs: improve structure for example templates (#9842)
Co-authored-by: Kyle Carberry <kyle@carberry.com> Co-authored-by: Muhammad Atif Ali <atif@coder.com> Co-authored-by: Muhammad Atif Ali <me@matifali.dev>
1 parent 3f6096b commit 2e86b76

File tree

38 files changed

+468
-1338
lines changed

38 files changed

+468
-1338
lines changed

‎cli/testdata/coder_templates_init_--help.golden

Lines changed: 1 addition & 1 deletion
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-ecs-container|aws-linux|aws-windows|azure-linux|do-linux|docker|docker-with-dotfiles|gcp-linux|gcp-vm-container|gcp-windows|kubernetes|nomad-docker
9+
--id aws-linux|aws-windows|azure-linux|do-linux|docker|gcp-linux|gcp-vm-container|gcp-windows|kubernetes|nomad-docker
1010
Specify a given example template by ID.
1111

1212
———

‎docs/cli/templates_init.md

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/dotfiles.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,6 @@ resource "coder_agent" "main" {
3232
}
3333
```
3434

35-
[Here's a complete example.](https://github.com/coder/coder/tree/main/examples/templates/docker-with-dotfiles#how-it-works)
36-
3735
## Persistent Home
3836

3937
Sometimes you want to support personalization without requiring dotfiles.

‎docs/platforms/jfrog.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ within a workspace. We'll use Docker as the underlying compute. But, these
88
concepts apply to any compute platform.
99

1010
The full example template can be found
11-
[here](https://github.com/coder/coder/tree/main/examples/templates/jfrog/docker).
11+
[here](https://github.com/coder/coder/tree/main/examples/jfrog/docker).
1212

1313
## Requirements
1414

@@ -249,7 +249,7 @@ for more information.
249249
## More reading
250250
251251
- See the full example template
252-
[here](https://github.com/coder/coder/tree/main/examples/templates/jfrog/docker).
252+
[here](https://github.com/coder/coder/tree/main/examples/jfrog/docker).
253253
- To serve extensions from your own VS Code Marketplace, check out
254254
[code-marketplace](https://github.com/coder/code-marketplace#artifactory-storage).
255255
- To store templates in Artifactory, check out our

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,8 +253,8 @@ Before using Podman, please review the following documentation:
253253
3. For systems running SELinux (typically Fedora-, CentOS-, and Red Hat-based
254254
systems), you might need to disable SELinux or set it to permissive mode.
255255
256-
4. Import our
257-
[kubernetes-with-podman](https://github.com/coder/coder/tree/main/examples/templates/kubernetes-with-podman)
256+
4. Use this
257+
[kubernetes-with-podman](https://github.com/coder/community-templates/tree/main/kubernetes-podman)
258258
example template, or make your own.
259259
260260
```shell

‎examples/examples.gen.json

Lines changed: 56 additions & 74 deletions
Large diffs are not rendered by default.

‎examples/examples.go

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,11 @@ var (
2323
// Only some templates are embedded that we want to display inside the UI.
2424
// The metadata in examples.gen.json is generated via scripts/examplegen.
2525
//go:embed examples.gen.json
26-
//go:embed templates/aws-ecs-container
2726
//go:embed templates/aws-linux
2827
//go:embed templates/aws-windows
2928
//go:embed templates/azure-linux
3029
//go:embed templates/do-linux
3130
//go:embed templates/docker
32-
//go:embed templates/docker-with-dotfiles
3331
//go:embed templates/gcp-linux
3432
//go:embed templates/gcp-vm-container
3533
//go:embed templates/gcp-windows

‎examples/templates/jfrog/docker/README.md renamed to ‎examples/jfrog/docker/README.md

File renamed without changes.

‎examples/templates/jfrog/docker/build/Dockerfile renamed to ‎examples/jfrog/docker/build/Dockerfile

File renamed without changes.

‎examples/templates/jfrog/docker/main.tf renamed to ‎examples/jfrog/docker/main.tf

File renamed without changes.

0 commit comments

Comments
 (0)