Skip to content

add detail to site-wide template policy doc #426

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.

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 4 commits into from
Jun 23, 2021

Conversation

bpmct
Copy link
Member

@bpmct bpmct commented Jun 22, 2021

This PR documents the fields that can be applied to template policies, as well as the behavior of the template policy on custom workspaces and workspaces that have conflicting values.

@bpmct bpmct requested review from Emyrk and khorne3 June 22, 2021 12:31
@bpmct bpmct changed the title Bpmct/clarify template policy add detail to site-wide template policy doc Jun 22, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Jun 22, 2021

✨ Coder.com for PR #426 deployed! It will be updated on every commit.

Comment on lines 27 to 28
- **append** - Workspaces can append items to the field, lists only (e.g
configure.start steps)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It works for lists or mappings. So labels for example is a mapping

@@ -20,38 +20,45 @@ If you enable the use of workspace templates, a **template policy** allows you
to control which fields users can set and which values can be used when they
define their workspaces.

The following policies can be applied to fields:

- **read** - Workspaces cannot modify the field
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to say that omitted policy is read by default?

@khorne3 khorne3 force-pushed the bpmct/clarify-template-policy branch from b1d4b5f to c1ab817 Compare June 22, 2021 15:04

- `read` - **Default.** Workspaces cannot modify the field
- `write` - Workspaces can overwrite the field
- `append` - Workspaces can append lists (e.g., configure.start steps) or
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is the comma here intended? @khorne3 e.g,?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bpmct yup it is!

@bpmct bpmct merged commit 60da934 into main Jun 23, 2021
@bpmct bpmct deleted the bpmct/clarify-template-policy branch June 23, 2021 01:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants