Repository navigation
docs(install): route the install landing pages to the control plane guides - #32405
Open
nickvigilante wants to merge 2 commits into
Conversation
…uides Lead the install landing page with the platform choices, so a reader who wants the control plane now can start without reading the planning phases first. Add an installation requirements page, point offline deployments to the air-gapped guide and the K3s tutorial, and point existing cloud clusters to the Kubernetes guide. Refs DOCS-1568
Separate Kubernetes from single-host containers in the platform questions, note that the Docker guide supports an external database, and add the TLS certificate that a wildcard access URL needs. Refs DOCS-1568
This branch has not been deployed
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Rework the install landing pages so a reader who wants the control plane right away can see where to go, without reading the planning phases first.
The sidebar order and every existing page URL stay the same; the only sidebar change is one new page.
Depends on #31869 (the air-gapped K3s tutorial), which this PR is stacked on and links to.
Refs DOCS-1568 and DOCS-1570.
Changes
install/index.md: leads with "Install the control plane now", which has three questions (internet access, Kubernetes or container or host, cloud or on premises) and a list of platform guides with Kubernetes recommended.It adds an offline subsection that points to the air-gap page and the K3s tutorial, a "Choose your path" table, a first-template step, and a "Move from evaluation to production" section.
The five phases move below the install path and become a table with a "When you can skip it" column.
install/server/requirements.md(Installation requirements): control plane CPU and memory, PostgreSQL, platform versions, network, internet access, and license, each traced to code or the existing platform pages.It's added as the first child of Install the control plane.
install/server/index.md: platform table gains a "Where the control plane runs" column (Rancher and OpenShift listed as Kubernetes), plus an offline section and a first-template step.install/server/kubernetes/index.md: intro names EKS, AKS, GKE, K3s, and OpenShift, and points offline clusters to the air-gap page and the K3s tutorial.install/server/cloud/index.md: sends existing EKS, AKS, and GKE clusters to the Kubernetes guide, notes that the AWS Marketplace guide creates a new EKS cluster, and fixes the Azure tab, which said GKE instead of AKS.install/plan/index.mdandinstall/prepare/index.md: planning reads as a recommendation, not a requirement, and Prepare links to the requirements page.Decisions for review
This reverses what I proposed in the Nov 4 install review (Rancher with container runtimes, OpenShift with Linux).
Both guides install the Helm chart on a cluster, so a reader looking for Kubernetes needs to find them.
This PR only changes the table labels and landing page wording; no pages move.
Prepare links to it.
coder/coderpages yet (DOCS-1795).Not in this PR
prepare/airgap.mdsays the built-in database downloads PostgreSQL fromrepo1.maven.org, butcli/server.gousesrepo.maven.apache.org.Known tradeoff: platform versions (Kubernetes 1.19, Helm 3.5, and so on) now appear on both the requirements page and each platform page, so a version bump has to update both.
Testing
make gen/docs-manifestandmake fmt/markdown.make lint/emdash lint/docs-html lint/docs-manifest lint/markdown lint/docs-redirects: all pass.The K3s tutorial links resolve only on top of docs: add an air-gapped K3s install tutorial #31869.
I applied the suggestions on Docker database wording, the wildcard TLS certificate, the Quickstart time, memory units, and the platform question wording.
Plan and decision log
Request. Add pages where they're needed, and update the existing landing pages so it's obvious where to go to install the control plane right away.
Don't rearrange the sidebar or rename pages.
Inputs.
What the feedback changed.
So the landing page lets readers install first and keeps Plan and Prepare visible as recommendations, with a "When you can skip it" column, rather than burying them.
The landing page now has a "Move from evaluation to production" section and a matching row in "Choose your path".
The K3s tutorial covers single-node evaluation only, so that gap is filed as DOCS-1798 instead of being written here without a tested run.
Choices made.
helm/libcoder/templates/_coder.yaml), Kubernetes version (helm/coder/Chart.yamlkubeVersion), built-in PostgreSQL download (cli/server.go), and the Kubernetes starter template's code-server install (examples/templates/kubernetes/main.tf).The K3s page title belongs to docs: add an air-gapped K3s install tutorial #31869, and the time target needs a timed run.
This PR repeats only short routing sentences.
This PR was generated by Coder Agents on behalf of @nickvigilante.