Repository navigation
docs: add quick paths to the install landing page and retire the CLI page - #31513
Merged
Merged
Conversation
ianjevans
approved these changes
Oct 30, 2026
ianjevans
left a comment
Collaborator
There was a problem hiding this comment.
Left one comment, but otherwise looks good.
| A single-server deployment fits an evaluation, a proof of concept, or a small team. | ||
|
|
||
| On a single server, Coder uses its built-in PostgreSQL database unless you set `CODER_PG_CONNECTION_URL`. | ||
| That removes the database from your prerequisites, which is the main reason the Quickstart is quick. |
Collaborator
There was a problem hiding this comment.
Is it that simple? Not e.g. sizing K8s nodes and setting up SSO?
Collaborator
Author
There was a problem hiding this comment.
It wasn't. My new agent thinks my previous agent hallucinated, so I made some updates for better accuracy.
nickvigilante
commented
Nov 2, 2026
|
|
||
| | If you want to | Start here | What you skip | | ||
| |----------------------------------------------|------------------------------------------------------------|--------------------------------------------------| | ||
| | See what Coder does on a single machine | [Quickstart](../get-started/index.md) | Planning, prerequisites, and validation | |
Collaborator
Author
There was a problem hiding this comment.
Don't use the word "see". Find another way to word this inclusively.
Comment on lines
+11
to
+18
| | If you want to | Start here | What you skip | | ||
| |----------------------------------------------|------------------------------------------------------------|--------------------------------------------------| | ||
| | See what Coder does on a single machine | [Quickstart](../get-started/index.md) | Planning, prerequisites, and validation | | ||
| | Install on a platform you've already chosen | [Install the control plane](./server/index.md) | Planning, unless you need to size the deployment | | ||
| | Deploy for a team, one step at a time | [The five phases](#the-five-phases), starting with phase 1 | Nothing | | ||
| | Choose a platform or size a deployment | [Plan your deployment](./plan/index.md) | Installation steps | | ||
| | Upgrade a deployment that's already running | [Upgrading](./operate/upgrade.md) | Everything except the upgrade guidance | | ||
| | Install only the `coder` command-line client | [Coder CLI](./cli.md) | The rest of this section | |
Collaborator
Author
There was a problem hiding this comment.
This should point users to coder.com/downloads instead. And as part of this PR, can we retire the CLI page?
| That removes the database from your prerequisites, which is the main reason the Quickstart is quick. | ||
| It also means the database lives on the same machine as Coder, so a deployment that people depend on needs a backup plan for that machine. | ||
|
|
||
| When you outgrow a single server, you don't start over. |
Collaborator
Author
There was a problem hiding this comment.
Suggested change
| When you outgrow a single server, you don't start over. | |
| When you outgrow a single server, you don't need to start over. |
| It also means the database lives on the same machine as Coder, so a deployment that people depend on needs a backup plan for that machine. | ||
|
|
||
| When you outgrow a single server, you don't start over. | ||
| Move the data to an external PostgreSQL database by following [Migrate from the built-in database to an external database](../admin/setup/index.md#migrate-from-the-built-in-database-to-an-external-database), then read [Plan your deployment](./plan/index.md) to decide how to grow. |
Collaborator
Author
There was a problem hiding this comment.
Suggested change
| Move the data to an external PostgreSQL database by following [Migrate from the built-in database to an external database](../admin/setup/index.md#migrate-from-the-built-in-database-to-an-external-database), then read [Plan your deployment](./plan/index.md) to decide how to grow. | |
| You can move the data to an external PostgreSQL database by following [Migrate from the built-in database to an external database](../admin/setup/index.md#migrate-from-the-built-in-database-to-an-external-database), then read [Plan your deployment](./plan/index.md) to decide how to grow. |
… landing page Replace the linear framing with a choose-your-path table, a single-server option, per-phase guidance on what each phase does and when to skip it, and a short list of decisions that are costly to change later. Assisted-by: AI
The single-server section credited the built-in database as the main reason the Quickstart is quick. The Quickstart also skips sizing, DNS and TLS (through the tunnel), the identity provider application, and the license, so name all of them and keep the database point for the backup guidance that follows.
Apply review feedback on the install landing page: reword the Quickstart row without "see", point the CLI-only row at coder.com/downloads, and soften the outgrow paragraph. Retire docs/install/cli.md, since the downloads page covers its install methods. Redirect /docs/install/cli to coder.com/downloads, remove the page from the manifest, and repoint every inbound link by intent: the downloads page for getting the binary, the CLI reference for usage, and the Quickstart for the install script. The deployment-hosted install script was the page's only unique content, so it moves to a new Install the CLI section in the workspace access guide.
nickvigilante
force-pushed
the
docs-install-landing-quick-paths
branch
from
November 2, 2026 16:52
5bff6d7 to
8ba2a2c
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The install landing page presented five phases that had to be read in order, which doesn't fit every install.
This keeps the five-phase structure and adds the flexibility discussed with Ben and Ian: put the options up front, offer shortcuts, and let users skip what doesn't apply.
It names what the Quickstart skips (sizing, DNS and TLS through the tunnel, the identity provider, the license, and the external database), explains what the built-in database means, and links to the migration steps for when users outgrow it.
The Slack discussion and the 1:1 described bundled versus external PostgreSQL as irreversible.
The docs already describe a migration path (
docs/admin/setup/index.md), so the page calls it costly instead: it needs downtime plus a dump and restore.Topology, size, and network position come from the existing Plan page.
Retire the CLI install page
coder.com/downloads now covers what
docs/install/cli.mdoffered, so the page is gone:/docs/install/cliredirects tohttps://coder.com/downloads, and the page is out of the sidebar.sessions-tokens.md,creating-templates.md,feature-stages.md), and the Quickstart's install step for running Coder with the install script (aws-marketplace.md).user-guides/workspace-access/index.md.The Zed and Claude Desktop guides link there.
This overlaps #31205, which edits
install/cli.md,zed.md, andrpm.md.Whichever merges second needs a rebase, and #31205 should drop its
cli.mdhunk.A separate PR can add per-phase "skip if" notes to the phase pages, and the install questionnaire stays a follow-up.
Checks:
make lint/emdash,lint/docs-html,lint/docs-manifest,lint/docs-redirects, markdownlint, and Vale.Vale's remaining findings on changed files are on lines this PR doesn't edit.
🤖 Generated with Coder Agents.