Skip to content

docs: fix broken extending-templates examples (dynamic-parameters, docker-in-workspaces) #28100

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

Draft
nickvigilante wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −5
Draft

docs: fix broken extending-templates examples (dynamic-parameters, docker-in-workspaces) #28100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions 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 @@ -145,7 +145,7 @@
[starter template](../../../../examples/templates/kubernetes-envbox)
or visit the [repo](https://github.com/coder/envbox).

### Authenticating with a Private Registry

Check warning on line 148 in docs/admin/templates/extending-templates/docker-in-workspaces.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading 

Heading starts with an -ing word ('Authenticating'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

Authenticating with a private container registry can be done by referencing the
credentials via the `CODER_IMAGE_PULL_SECRET` environment variable. It is
Expand Down Expand Up @@ -252,8 +252,8 @@
example template, or make your own.

```sh
echo "kubernetes-with-podman" | coder templates init
cd ./kubernetes-with-podman
git clone https://github.com/coder/community-templates
cd community-templates/kubernetes-podman
coder templates create
```

Expand Down
3 changes: 0 additions & 3 deletions docs/admin/templates/extending-templates/dynamic-parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -526,9 +526,6 @@
}

data "coder_parameter" "cpu_cores" {
# Only show this parameter if the previous box is selected.
count = data.coder_parameter.show_cpu_cores.value ? 1 : 0

name = "cpu_cores"
display_name = "CPU Cores"
type = "number"
Expand Down Expand Up @@ -801,7 +798,7 @@
Enabling Dynamic Parameters on an existing template requires administrators to publish a new template version.
This will resolve the necessary template metadata to render the form.

### Reverting to classic parameters

Check warning on line 801 in docs/admin/templates/extending-templates/dynamic-parameters.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading 

Heading starts with an -ing word ('Reverting'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

The classic parameter flow is deprecated and can no longer be enabled from the UI.
A template can still opt out of Dynamic Parameters by setting the `use_classic_parameter_flow`
Expand Down
Loading