Skip to content

Make instance type info more discoverable #3445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 15, 2025
Merged

Conversation

paigecalvert
Copy link
Contributor

@paigecalvert paigecalvert commented Aug 13, 2025

@paigecalvert paigecalvert requested a review from a team as a code owner August 13, 2025 18:08
Copy link

netlify bot commented Aug 13, 2025

Deploy Preview for replicated-docs ready!

Name Link
🔨 Latest commit ae74b03
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs/deploys/689fa62790b8810008b6e73b
😎 Deploy Preview https://deploy-preview-3445--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.

Copy link

netlify bot commented Aug 13, 2025

Deploy Preview for replicated-docs-upgrade ready!

Name Link
🔨 Latest commit ae74b03
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs-upgrade/deploys/689fa6278b10680008bac954
😎 Deploy Preview https://deploy-preview-3445--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.

{
type: 'category',
label: 'Use Compatibility Matrix',
items: [
'vendor/testing-how-to',
'vendor/testing-supported-clusters',
'vendor/testing-ingress',
'vendor/testing-cluster-addons',
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ moves the rest of the clusters stuff under "Use CMX" alongside corresponding VMs topics

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! I like this organization.
2025-08-15 - 17 04@2x

How about making these titles more consistent and shorter? Since they are already under a group with the words "Compatibility Matrix"

  • Create Clusters
  • Cluster Types
  • Cluster Networking
  • Cluster Add-ons (Alpha)
  • Create VMs (Beta)
  • VM Networking (Beta)
  • Use Compatibility Matrix with CI/CD

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a great idea--some of those older ones are definitely on the long side... I'll do a separate story for that since I'll also need to update all the cross-references to these pages after changing the titles


The following describes the Replicated instance types for VMs:

<InstanceTypes/>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ I had a hard time finding this instance types info when I was creating a VM the other day. Previously, it was just in the "Supported Cluster Types" topic. Added to a partial so it can appear here as well

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much better!

@@ -1,4 +1,4 @@
# Access Your Application
# Cluster Networking
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ updated this page title to better match the "VM Networking" pattern. Before, it wasn't clear that it was specific to clusters

@paigecalvert paigecalvert requested a review from hyu August 13, 2025 19:48
hyu
hyu previously approved these changes Aug 15, 2025
Copy link
Contributor

@hyu hyu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definite improvement!

@paigecalvert paigecalvert merged commit 84de457 into main Aug 15, 2025
1 check failed
@paigecalvert paigecalvert deleted the cmx-vms-repl-instances branch August 15, 2025 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants