Split validator deployment back into Docker Compose and Kubernetes pages#289
Merged
hrischuk-da merged 5 commits intomainfrom May 5, 2026
Merged
Split validator deployment back into Docker Compose and Kubernetes pages#289hrischuk-da merged 5 commits intomainfrom
hrischuk-da merged 5 commits intomainfrom
Conversation
The merged 1019-line installation.mdx page covered both Docker Compose
and Kubernetes validator deployment with a Tabs control. The reviewer
flagged this as inappropriate (these are mutually-exclusive deployment
methods) and asked to revert to the upstream pattern of two separate
pages with "Deployment Options" as the parent TOC entry.
Page split:
- F-045 (item 46): Created two new pages by extracting from
installation.mdx via copy_section.py for the shared sub-sections
(Before you begin, Download bundle, First startup verification, Next
steps) and line-range slicing for the two upstream COPIED blocks
(validator_helm.rst lines 176-723, validator_compose.rst lines
726-900):
- validator-docker-compose.mdx (287 lines): shared intro + Docker
Compose installation steps + full validator_compose.rst block
- validator-kubernetes.mdx (renamed from installation.mdx for git
history): shared intro + Kubernetes installation steps + full
validator_helm.rst block
- Embedded body h1s stripped from both new pages per lessons-learned
(frontmatter title is the canonical h1).
- Verbatim verification: md5 of each COPIED block confirmed present in
the corresponding new page.
docs.json:
- Replaced the flat deployment-options + installation entries with a
Deployment Options sub-group containing the existing landing page +
the two new validator pages (3x version blocks). Reviewer's request
was "Make the Deployment Options have docker and k8s as children
TOC entries."
- Redirect added: installation -> deployment-options.
Cross-reference cleanup:
- Updated 6 internal links across deployment-options, onboarding-process,
prerequisites, super-validator-setup that pointed to the old
/installation slug. They now point to /deployment-options (the parent
of the two split pages).
- Updated deployment-options.mdx Next Steps cards to point to the two
new specific pages instead of the old /installation.
installation.mdx (1019 lines) deleted; the content is preserved across
the two new pages with verbatim COPIED blocks.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
hrischuk-da
reviewed
May 1, 2026
| title: "Installation" | ||
| description: "Step-by-step installation of a Canton Network validator using Docker Compose or Kubernetes" | ||
| title: "Kubernetes Validator Deployment" | ||
| description: "Deploy a Canton Network validator on Kubernetes using Helm charts" |
Contributor
There was a problem hiding this comment.
@8bitpal where is the content for deploying via k8s? I would have expected some content like https://docs.sync.global/validator_operator/validator_helm.html.
Collaborator
Author
There was a problem hiding this comment.
page now renders the full upstream validator_helm.rst content (Requirements, Network Diagram, Preparing a Cluster, HTTP Proxy config, PostgreSQL auth, Validator Onboarding, OIDC, Helm install, Ingress, Wallet UI, Auto traffic top-up, Sweeps/auto-accept) plus the page-level installation steps at the top.
…etes,docker-compose}.mdx - Resolve docs.json redirects array: keep installation→deployment-options redirect (this PR) plus sv-scratchnet/network-connectivity/infrastructure-requirements redirects (from PR #286 merged to main). - Strip leftover `<Tabs>` and `<Tab title="Docker Compose">` openers (no closers) from validator-kubernetes.mdx and validator-docker-compose.mdx. These were residue from when Docker Compose and Kubernetes shared a tabbed installation.mdx. After the page split, the wrapper made every page render as a single mis-labelled "Docker Compose" tab and produced unmatched JSX. Reviewer Curtis flagged this on validator-kubernetes.mdx as "where is the content for deploying via k8s?" — the content was below the broken tab wrapper.
hrischuk-da
approved these changes
May 5, 2026
8bitpal
added a commit
that referenced
this pull request
May 6, 2026
…ation Conflicts and resolutions: open-tracing.mdx (add/add): Both sides created identical pages from the same upstream source; only difference was image-path style. Took main's version with the ./images/jaegerPingSpans.png convention used consistently across the repo. da-fail.mdx: HEAD had this branch's internal-link migration to /appdev/reference/error-codes; main had the original external link but with <span> instead of <a> (a Mintlify CLI validation fix). Combined: kept the internal link and main's <span> id markup. getting-started-tutorial.mdx: Both sides edited a TODO comment about smart-contract walkthroughs. HEAD pointed at the internal Java bindings page; main retained the external docs.daml.com URL. Kept HEAD — link migration is this branch's purpose. validator-kubernetes.mdx (rename of installation.mdx): Main split installation.mdx into validator-docker-compose.mdx and validator-kubernetes.mdx in #289. Took main's version of validator-kubernetes.mdx, then re-applied this branch's pruning link migration (docs.daml.com/ops/pruning.html and docs.daml.com/canton/usermanual/pruning.html -> /global-synchronizer/production-operations/pruning). validator-docker-compose.mdx (auto-merged as new): Applied this branch's JSON Ledger API and gRPC Ledger API link migrations there too — git's rename detection routed them only to the kubernetes side, leaving docker-compose with the old docs.digitalasset.com URLs.
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
2 participants
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
Continuing through the 2026-04-27 review. reviewer flagged that the merged
installation.mdxpage (1019 lines, with a<Tabs>control switching between Docker Compose and Kubernetes deployment instructions) is inappropriate because these are mutually-exclusive deployment methods, and asked to revert to the upstream pattern of two separate pages under a "Deployment Options" parent TOC entry.7 files changed, +346 / -393 lines — net reduction is from removing the duplicated intro/onboarding content the merged page carried.
Page split (F-045 / item 46)
The 1019-line
installation.mdxis split into two new pages, with the existingdeployment-options.mdxbecoming the parent landing of aDeployment Optionssub-group.validator-docker-compose.mdxvalidator_compose.rstupstream COPIED block + verification checklist + Next Steps. Embedded body h1 stripped per the lessons-learned rule (frontmatter title is the canonical h1).validator-kubernetes.mdxinstallation.mdxfor git history). Shared intro + Kubernetes installation steps + the fullvalidator_helm.rstupstream COPIED block + verification + Next Steps. Embedded body h1 stripped.installation.mdxdeployment-options.Verbatim verification
Both upstream COPIED blocks preserved byte-for-byte:
validator_compose.rstblock:md5=6ed08122164a3ce90f7bbc1d817389b5, 14587 bytes — verified present invalidator-docker-compose.mdx.validator_helm.rstblock:md5=0578230b0ee1b13985cf6d6c96e9cd99, 38376 bytes — verified present invalidator-kubernetes.mdx.Extraction approach: line-range slicing for the two large COPIED blocks (since the COPIED markers wrap the heading rather than starting at it);
.internal/scripts/copy_section.pyfor the shared sub-sections (Before you begin, Download bundle, tab bodies, First startup verification, Next steps); trailing</Tab>JSX trimmed from the tab-body extractions.docs.jsondeployment-options+installationentries with aDeployment Optionssub-group containing the existing landing + the two new validator pages, in each version block (MainNet × TestNet × DevNet). Matches the reviewer's "Deployment Options should have docker and k8s as children TOC entries."/installation→/deployment-options(the parent of the two split pages).Cross-reference cleanup
6 internal links updated to point at
/deployment-options(the parent landing) instead of the deleted/installationslug:deployment-options.mdx(1) — Next Steps cardonboarding-process.mdx(2)prerequisites.mdx(1)super-validator-setup.mdx(2)deployment-options.mdxNext Steps now has two specific cards: Docker Compose validator deployment, Kubernetes validator deployment.