Skip to content

Overhaul CMX Docs#3703

Closed
hyu wants to merge 7 commits intomainfrom
han-cmx-unified
Closed

Overhaul CMX Docs#3703
hyu wants to merge 7 commits intomainfrom
han-cmx-unified

Conversation

@hyu
Copy link
Copy Markdown
Contributor

@hyu hyu commented Dec 9, 2025

Overhaul CMX documentation for better clarity and discoverability. Rewrite to support a GUI refresh (PR) where all CMX options are visible in one view.

Goal: Approachable and simple, but powerful if you dig in.

Changes

New Pages:

STILL WIP! But, below is the plan…

  • cmx-overview.md - Why should I use this? What's the difference between VMs and Clusters?
  • cmx-vms.md - Comprehensive VM guide (SSH, file transfers, creation)
  • cmx-develop.md - Dev workflows (cluster prepare, access, upgrades)
  • cmx-networking.md - Networking, both external and internal (port exposure, tunnels, shared networks)

Use cases:

  • cmx-airgap.md - Air gap testing and network reporting

Removed:

  • testing-about.md - Consolidated into cmx-overview.md
  • testing-cluster-addons.md - Content distributed to relevant pages

Updated:

  • Streamlined testing-how-to.md to focus on cluster management
  • Reorganized sidebar navigation for logical flow
  • Fixed cross-references throughout documentation

Structure

Overview → VMs → Clusters → Networking → Air Gap → Development → CI/CD

@hyu hyu requested a review from a team as a code owner December 9, 2025 18:23
@netlify
Copy link
Copy Markdown

netlify Bot commented Dec 9, 2025

Deploy Preview for replicated-docs ready!

Name Link
🔨 Latest commit a9636df
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs/deploys/693c666d1a765d0008270e3f
😎 Deploy Preview https://deploy-preview-3703--replicated-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link
Copy Markdown

netlify Bot commented Dec 9, 2025

Deploy Preview for replicated-docs-upgrade ready!

Name Link
🔨 Latest commit a9636df
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs-upgrade/deploys/693c666dbf08970008ac336e
😎 Deploy Preview https://deploy-preview-3703--replicated-docs-upgrade.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@replicated-ci replicated-ci added type::docs Improvements or additions to documentation type::feature labels Dec 9, 2025
@hyu hyu marked this pull request as draft December 9, 2025 18:23
@paigecalvert
Copy link
Copy Markdown
Contributor

@hyu I'm going to close this out in favor of #3779. We can (and should!) reference your changes here if there's anything we want to incorporate in future iterations

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type::docs Improvements or additions to documentation type::feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants