mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
Nick Vigilante
c84aa564ba
Normalizes non-standard code-fence language tags across `docs/**` so a strict highlighter (Shiki, used by Fumadocs) won't fail the build on an unrecognized language, and unifies redundant synonym tags onto one canonical form per language. The current renderer (Speed-Highlight) detects the language from the code content, not the fence label, so this drift wasn't visible until now. ## Changes - `hcl` -> `tf` (199 fences, including indented ones nested in numbered/bulleted lists). Shiki ships `hcl` and `terraform` as two distinct grammars (not aliases); every `hcl`-tagged fence in `docs/**` is actually Terraform resource/data/provider syntax, so the more specific `terraform` grammar is correct for all of them. `tf` is Shiki's own alias for that grammar, and it's also what GitHub's own markdown renderer resolves to the same HCL/Terraform highlighting. - `pwsh`/`powershell` -> `ps1`. Both `ps` and `ps1` are registered PowerShell aliases in Shiki, but on GitHub's renderer only `.ps1` is a registered file extension (`.ps` isn't), so `ps1` renders identically to `powershell` there today while bare `ps` would silently lose highlighting. - `env` -> `dotenv` (a dedicated Shiki grammar for `KEY=VALUE` files) - `text`/`output`/`none`/`url` -> `txt`. Same built-in plain-text fallback either way, just shorter. - `Dockerfile` -> `dockerfile` (lowercase) - `bash`/`shell` -> `sh` (732 fences). Shiki and GitHub both alias all three to a single shell grammar; this was already the style guide's stated preference, just not enforced across the existing corpus until now. - `markdown` -> `md` (4 fences). Alias of the same grammar in both Shiki and GitHub. - `jsonc` -> `json` (1 fence). The block has no comments or trailing commas, so it doesn't need the comments-capable grammar. - `ts` -> `tsx` (2 fences, `docs/about/contributing/frontend.md`). Verified the actual content tokenizes identically under both grammars, and a sibling block in the same file already needs `tsx` for real JSX, so unifying to one tag is safe for this file. Documented a caveat: `tsx` mis-tokenizes the legacy angle-bracket type-assertion syntax (`<Type>value`), which is invalid in real `.tsx` files anyway, so use `value as Type` instead. - `yml` -> `yaml` (1 fence) - Updated `docs/.style/style-guide/formatting.md` to document all canonical tags `promql` (2 fences) and `caddyfile` (2 fences) are left as-is. Shiki doesn't bundle a grammar for either, so they need a custom grammar registration when the site adopts Shiki, rather than degrading to `txt`. Tracked as follow-up work under DOCS-118 and [DOCS-544](https://linear.app/codercom/issue/DOCS-544/vendor-a-local-promql-grammar-for-shiki-syntax-highlighting) (promql). Does not touch `offlinedocs/`. Linear: [DOCS-476](https://linear.app/codercom/issue/DOCS-476/normalize-docs-code-fence-languages-de-risk-shikifumadocs) <details> <summary>How the fence tags were verified</summary> Each tag was tested against a real `shiki@latest` highlighter instance (`codeToHtml`/`codeToTokens`) and cross-checked against GitHub's `@wooorm/starry-night` grammar sources (the renderer that actually displays these `.md` files today, in repo browsing and PR diffs), since that's what determines whether brevity is safe before Shiki adoption: ```text FAIL env -- Language `env` is not included in this bundle. FAIL Dockerfile -- Language `Dockerfile` is not included in this bundle. FAIL promql -- Language `promql` is not included in this bundle. FAIL caddyfile -- Language `caddyfile` is not included in this bundle. FAIL pwsh -- Language `pwsh` is not included in this bundle. FAIL output -- Language `output` is not included in this bundle. ``` `hcl` doesn't error in Shiki, since it's a real grammar, but that's exactly the trap: it was silently rendering every fence with the generic HCL grammar instead of the Terraform-specific one. Every `hcl`-tagged fence in `docs/**` was manually checked against `origin/main` and is genuinely Terraform content. For `ts`/`tsx`, tokenizing the actual doc content confirmed identical output under both grammars; a synthetic test with the legacy angle-bracket cast syntax confirmed `tsx` degrades on that specific construct, which the style guide now calls out. The first normalization pass only matched fence tags at column 0 (`^```tag$`), missing tags indented inside numbered/bulleted lists. A follow-up pass caught the remaining occurrences at any indentation level. </details> --- *This PR description and the underlying changes were prepared with Coder Agents assistance.*
82 lines
3.3 KiB
Markdown
82 lines
3.3 KiB
Markdown
# Google Cloud Platform
|
|
|
|
In this guide, you will learn how to deploy the Coder control plane instance and
|
|
your first template.
|
|
|
|
## Requirements
|
|
|
|
This guide assumes you have `roles/compute.instanceAdmin.v1` access to your
|
|
Google Cloud Platform project.
|
|
|
|
## Launch a Coder instance from the Google Cloud Marketplace
|
|
|
|
We publish an Ubuntu 22.04 VM image with Coder and Docker pre-installed.
|
|
|
|
Two SKU's are available via the Google Cloud Marketplace:
|
|
|
|
1. [License purchase via Google Cloud Marketplace](https://console.cloud.google.com/marketplace/product/coder-enterprise-market-public/coder-gcmp?inv=1&invt=Ab45rg&project=secret-beacon-468405-p5)
|
|
2. [A solution to deploy VM's on GCP (Bring Your Own License)](https://console.cloud.google.com/marketplace/product/workspan-public-422119/coder?inv=1&invt=Ab45rg&project=secret-beacon-468405-p5)
|
|
|
|
|
|
|
|
Be sure to keep the default firewall options checked so you can connect over
|
|
HTTP, HTTPS, and SSH.
|
|
|
|
We recommend keeping the default instance type (`e2-standard-4`, 4 cores and 16
|
|
GB memory) if you plan on provisioning Docker containers as workspaces on this
|
|
VM instance. Keep in mind this platforms is intended for proof-of-concept
|
|
deployments and you should adjust your infrastructure when preparing for
|
|
production use. See: [Scaling Coder](../../admin/infrastructure/index.md)
|
|
|
|
<video autoplay playsinline loop>
|
|
<source src="../../images/platforms/gcp/launch.mp4?raw=true" type="video/mp4">
|
|
Your browser does not support the video tag.
|
|
</video>
|
|
|
|
Be sure to add a keypair so that you can connect over SSH to further
|
|
[configure Coder](../../admin/setup/index.md).
|
|
|
|
After launching the instance, wait 30 seconds and navigate to the public IPv4
|
|
address. You should be redirected to a public tunnel URL.
|
|
|
|
|
|
|
|
That's all! Use the UI to create your first user, template, and workspace. We
|
|
recommend starting with a Docker template since the instance has Docker
|
|
pre-installed.
|
|
|
|
|
|
|
|
## Configuring Coder server
|
|
|
|
Coder is primarily configured by server-side flags and environment variables.
|
|
Given you created or added key-pairs when launching the instance, you can
|
|
[configure your Coder deployment](../../admin/setup/index.md) by logging in via
|
|
SSH or using the console:
|
|
|
|
```sh
|
|
ssh ubuntu@<gcp-public-IPv4>
|
|
sudo vim /etc/coder.d/coder.env # edit config
|
|
sudo systemctl daemon-reload
|
|
sudo systemctl restart coder # restart Coder
|
|
```
|
|
|
|
## Give developers VM workspaces (optional)
|
|
|
|
Instead of running containers on the Coder instance, you can offer developers
|
|
full VM instances with the
|
|
[gcp-linux](../../../examples/templates/gcp-linux/README.md)
|
|
template.
|
|
|
|
Before you can use this template, you must authorize Coder to create VM
|
|
instances in your GCP project. Follow the instructions in the
|
|
[gcp-linux template README](../../../examples/templates/gcp-linux/README.md#authentication)
|
|
to set up authentication.
|
|
|
|
### Next Steps
|
|
|
|
- [Use your IDE with Coder](../../user-guides/workspace-access/index.md)
|
|
- [Writing custom templates for Coder](../../admin/templates/index.md)
|
|
- [Configure the Coder server](../../admin/setup/index.md)
|
|
- [Use your own domain + TLS](../../admin/setup/index.md#tls--reverse-proxy)
|