Condense cmx pages and remove out of date content #3779
Conversation
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
| import Prerequisites from "../partials/cmx/_prerequisites.mdx" | ||
| import InstanceTypes from "../partials/cmx/_instance-types.mdx" | ||
|
|
||
| # About CMX |
There was a problem hiding this comment.
One conceptual overview topic for CMX. Includes requirements and limitations, and some info about billing. Could expand on the "use cases" portion as needed, add a workflow diagram, etc
| import Prerequisites from "../partials/cmx/_prerequisites.mdx" | ||
|
|
||
| # Use CMX Clusters | ||
| # Create and Manage Environments with CMX |
There was a problem hiding this comment.
One topic on how to create and manage environments (clusters and VMs). Includes info about prereqs for using cmx, creating environments, air-gapping environments, using shared networks, accessing environments, editing, deleting. Every main task related to standing up environments that applies to both clusters and VMs
| @@ -1,8 +1,112 @@ | |||
| # CMX Cluster Networking | |||
| # Access Applications in CMX Environments | |||
There was a problem hiding this comment.
One topic on how to access applications in cmx environments (ingress, exposing ports, networking options)
Could expand on this to explain more of the use cases here and how this fits into your testing workflows
| import TestRecs from "../partials/ci-cd/_test-recs.mdx" | ||
|
|
||
| # Test in CMX with CI/CD | ||
| # Test in CMX Environments with CI/CD |
There was a problem hiding this comment.
no edits to this page as part of this PR, but it could use a review
| @@ -1,153 +1,47 @@ | |||
| # Test in Air Gap Environments (Beta) | |||
| # Collect and View Network Reports | |||
There was a problem hiding this comment.
One topic about collecting and viewing network reports, separate from info about network policies (which is in the main how-to topic grouped together with other info about creating environments)
| import InstanceTypes from "../partials/cmx/_instance-types.mdx" | ||
|
|
||
| # CMX Cluster Types | ||
| # CMX Cluster and VM Types |
There was a problem hiding this comment.
There was space on this topic to bring over the VM types, so that we only have one page about support environment types. Need to confirm if this messes up any automation the team has for updating the info about supported cluster distros and versions
| This topic describes how to use Replicated Compatibility Matrix (CMX) to create and manage ephemeral VMs. | ||
|
|
||
| ## Set Up SSH Access | ||
| # Connect to CMX VMs (SSH and File Transfer) |
There was a problem hiding this comment.
Changed the purpose of this topic so that it's specifically about connecting to VMs.
Pulled this info out of the main how-to because it is specific to VMs, because of the one-time nature of SSH setup, and because of the ability to group it with info about transferring files which is a common task when testing installs
Note that the step of how to run the ssh command to ssh into vms is also over in the main how-to topic under "access environments"
There was a problem hiding this comment.
Was able to delete these two partials since the content is no longer reused across multiple pages
Preview: https://deploy-preview-3779--replicated-docs.netlify.app/vendor/testing-about
