opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve structure for example templates (#9842)

Browse Source 
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>
This commit is contained in:
Ben Potter
2023-12-17 17:05:13 +03:00
committed by GitHub
co-authored by Kyle Carberry Muhammad Atif Ali Muhammad Atif Ali
parent 3f6096b0d7
commit 2e86b76fb8
38 changed files with 473 additions and 1343 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/cli/templates_init.md
Generated
+3 -3
View File
@@ -14,8 +14,8 @@ coder templates init [flags] [directory]
### --id
| | |
| ---- | ---------------------------- | --------- | ----------- | ----------- | -------- | ------ | -------------------- | --------- | ---------------- | ----------- | ---------- | -------------------- |
| Type | <code>enum[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]</code> |
| | |
| ---- | -------------------- | ----------- | ----------- | -------- | ------ | --------- | ---------------- | ----------- | ---------- | -------------------- |
| Type | <code>enum[aws-linux | aws-windows | azure-linux | do-linux | docker | gcp-linux | gcp-vm-container | gcp-windows | kubernetes | nomad-docker]</code> |
Specify a given example template by ID.
docs/dotfiles.md
-2
View File
@@ -32,8 +32,6 @@ resource "coder_agent" "main" {
}
```
[Here's a complete example.](https://github.com/coder/coder/tree/main/examples/templates/docker-with-dotfiles#how-it-works)
## Persistent Home
Sometimes you want to support personalization without requiring dotfiles.
docs/platforms/jfrog.md
+2 -2
View File
@@ -8,7 +8,7 @@ within a workspace. We'll use Docker as the underlying compute. But, these
concepts apply to any compute platform.
The full example template can be found
[here](https://github.com/coder/coder/tree/main/examples/templates/jfrog/docker).
[here](https://github.com/coder/coder/tree/main/examples/jfrog/docker).
## Requirements
@@ -249,7 +249,7 @@ for more information.
## More reading
- See the full example template
[here](https://github.com/coder/coder/tree/main/examples/templates/jfrog/docker).
[here](https://github.com/coder/coder/tree/main/examples/jfrog/docker).
- To serve extensions from your own VS Code Marketplace, check out
[code-marketplace](https://github.com/coder/code-marketplace#artifactory-storage).
- To store templates in Artifactory, check out our
docs/templates/docker-in-workspaces.md
Vendored
+2 -2
View File
@@ -253,8 +253,8 @@ Before using Podman, please review the following documentation:
3. For systems running SELinux (typically Fedora-, CentOS-, and Red Hat-based
systems), you might need to disable SELinux or set it to permissive mode.
4. Import our
[kubernetes-with-podman](https://github.com/coder/coder/tree/main/examples/templates/kubernetes-with-podman)
4. Use this
[kubernetes-with-podman](https://github.com/coder/community-templates/tree/main/kubernetes-podman)
example template, or make your own.
```shell