Skip to content

hotfix: Templates language [ch14098] #466

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 5 commits into from
Jul 6, 2021
Merged

Conversation

greyscaled
Copy link
Contributor

This implements task 2 (documentation) for normalizing the language
around workspace templates.

Details:

  • Rename workspaces-as-code directory to workspace-templates
  • Replace WAC and Workspaces as code with workspace templates

This implements task 2 (documentation) for normalizing the language
around workspace templates.

Details:

* Rename workspaces-as-code directory to workspace-templates
* Replace WAC and Workspaces as code with workspace templates
@greyscaled greyscaled self-assigned this Jul 6, 2021
@shortcut-integration
Copy link

This pull request has been linked to Clubhouse Story #14098: Inconsistent language around Workspaces as Code.

@greyscaled greyscaled requested a review from khorne3 July 6, 2021 19:39
@github-actions
Copy link
Contributor

github-actions bot commented Jul 6, 2021

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

@@ -1,6 +1,7 @@
---
title: "Workspace template code completion"
description: "Learn how to use code completion when creating workspace templates."
description:
"Learn how to use code completion when creating workspace templates."
Copy link
Contributor

Choose a reason for hiding this comment

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

I think having this on two lines breaks the build

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Prettier did this, not me. Hmm I'll check it out - currently running build based off of the suggestions before this

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, Prettier will do that so I just manually format all but the metadata (I'm sure there's a better way, but that's how I've been doing it :))

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@khorne3 - everything on the preview seems fine 😕

preview-1

Copy link
Contributor

Choose a reason for hiding this comment

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

I stand corrected! Good to see this won't be a problem anymore

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yea me too. If it ended up causing a problem, I'd argue that it's something we'd have to consider filing upstream to prettier or addressing in our prettier config. Otherwise it implies that a code formatter (strictly formatting) is having an unintended output consequence. That kind of defeats the purpose of what prettier is supposed to be doing, though I imagine there are few edge cases where this has happened (ex: <pre> tags).

Great stuff though - hopefully this means everyone can just enable the prettier VS Code extension and trust ctrl + save :p - afterall, that's all I did!

greyscaled and others added 2 commits July 6, 2021 16:20
Co-authored-by: Katie Horne <katie@coder.com>
Co-authored-by: Katie Horne <katie@coder.com>
@greyscaled greyscaled merged commit 4f68180 into main Jul 6, 2021
@greyscaled greyscaled deleted the vapurrmaid/ch14098/docs-task branch July 6, 2021 21:16
jawnsy added a commit that referenced this pull request Jul 14, 2021
* hotfix: Templates language [ch14098] (#466)

* hotfix: Templates language [ch14098]

This implements task 2 (documentation) for normalizing the language
around workspace templates.

Details:

* Rename workspaces-as-code directory to workspace-templates
* Replace WAC and Workspaces as code with workspace templates

Co-authored-by: Katie Horne <katie@coder.com>

* chore: add status information to workspaces (#443)

* [ImgBot] Optimize images (#469)

*Total -- 195.86kb -> 172.63kb (11.86%)

/assets/workspaces/workspace-overview.png -- 134.26kb -> 116.30kb (13.37%)
/assets/workspaces/status-chip.png -- 61.60kb -> 56.33kb (8.56%)

Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>

Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>

* Add Getting Started Doc (#458)

* fix formatting issues in k3s docs (#477)

* Expand instructions on creating a configure file (#476)

* chore: bump husky from 7.0.0 to 7.0.1 (#464)

Bumps [husky](https://github.com/typicode/husky) from 7.0.0 to 7.0.1.
- [Release notes](https://github.com/typicode/husky/releases)
- [Commits](typicode/husky@v7.0.0...v7.0.1)

---
updated-dependencies:
- dependency-name: husky
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore: bump @types/minimist from 1.2.1 to 1.2.2 (#468)

Bumps [@types/minimist](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/minimist) from 1.2.1 to 1.2.2.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/minimist)

---
updated-dependencies:
- dependency-name: "@types/minimist"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore: document special case re: GitHub and callback/dev URLs (#475)

chore: document special case re: GitHub and callback/dev URLs

Co-authored-by: Ben Potter <me@bpmct.net>

* chore: update dependabot version ignores (#478)

* Open pull requests for major version updates for GitHub Actions
* Ignore version updates for Node.js types

* chore: bump @types/node from 12.20.15 to 12.20.16 (#481)

Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 12.20.15 to 12.20.16.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore: clarify version support policy (#232)

Recommend that users track supported Kubernetes versions, and remove
the reference to version 1.13.

Co-authored-by: Katie Horne <katie@coder.com>

* Begin Openshift docs

Document openshift image tweaks required.
Omit docs on how to use openshift registry

* add buildconfig example

* change list style

* add more detaila bout security context settings

* Begin Openshift docs

Document openshift image tweaks required.
Omit docs on how to use openshift registry

* add buildconfig example

* change list style

* add more detaila bout security context settings

* Edit text

Co-authored-by: G r e y <grey@coder.com>
Co-authored-by: Katie Horne <katie@coder.com>
Co-authored-by: imgbot[bot] <31301654+imgbot[bot]@users.noreply.github.com>
Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>
Co-authored-by: Thomas Hughes <2894107+IAmHughes@users.noreply.github.com>
Co-authored-by: Ben Potter <me@bpmct.net>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Jonathan Yu <jonathan@coder.com>
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.

2 participants