Skip to content

Conversation

@guowenatk
Copy link
Contributor

@guowenatk guowenatk commented Nov 4, 2025

Content Description

Add documentation about registration of host clusters

Preview Link

https://deploy-preview-1340--vcluster-docs-site.netlify.app/docs/platform/next/administer/clusters/connect-cluster

Internal Reference

Closes DOC-429

@netlify /docs

@guowenatk guowenatk requested a review from a team as a code owner November 4, 2025 14:29
@netlify
Copy link

netlify bot commented Nov 4, 2025

Deploy Preview for vcluster-docs-site ready!

Name Link
🔨 Latest commit fc9117b
🔍 Latest deploy log https://app.netlify.com/projects/vcluster-docs-site/deploys/6932de65689afd0008ff2061
😎 Deploy Preview https://deploy-preview-1340--vcluster-docs-site.netlify.app/docs
📱 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.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2025

Copy link
Contributor

@Piotr1215 Piotr1215 left a comment

Choose a reason for hiding this comment

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

@guowenatk this fits better in the Administer section:

Image

Copy link
Contributor

@Piotr1215 Piotr1215 left a comment

Choose a reason for hiding this comment

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

Some more comments/suggestions.

@guowenatk
Copy link
Contributor Author

This page https://deploy-preview-1340--vcluster-docs-site.netlify.app/docs/platform/next/administer/clusters/connect-cluster already contains plenty info about how to register the host cluster to the platform. I will merge the changes of this PR into that page.

Copy link
Contributor

@Piotr1215 Piotr1215 left a comment

Choose a reason for hiding this comment

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

@guowenatk
Consolidating things into existing pages, could work, but we need to address the review comments I left on the original file. They still apply.

Quick things to fix:

  1. Scope issue: This PR is mixing "connecting clusters" with "upgrading agents". DOC-429 is about connecting/adding clusters with Helm, not upgrading existing ones. The upgrade stuff already lives in cluster-upgrades.mdx.

  2. Review comments: The inline comments I left aren't optional - we need them for consistency:

    • <Flow> and <Step> components (see other pages for examples)
    • Explain what a host cluster is upfront
    • Call out required permissions + link to permissions page
    • Proper :::info admonitions
    • Link "vCluster Platform agent" to agent docs
  3. Structure: Consolidating into connect-cluster.mdx is fine, but formatting standards still apply.

Please go through my comments and implement them.

@guowenatk guowenatk requested a review from Piotr1215 November 10, 2025 14:10
@guowenatk guowenatk force-pushed the doc-429/install-agent branch from 4dc388f to 2b3870c Compare December 1, 2025 14:05
@Piotr1215
Copy link
Contributor

@pascalbreuninger thank you for detailed review. @guowenatk let's resolve merge conflicts and push the version as is with Pascal's comments, we will iterate if needed.

@guowenatk guowenatk force-pushed the doc-429/install-agent branch from df14aec to 651901f Compare December 5, 2025 12:46
@Piotr1215 Piotr1215 merged commit d421c30 into main Dec 18, 2025
16 checks passed
@Piotr1215 Piotr1215 deleted the doc-429/install-agent branch December 18, 2025 15:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants