Skip to content

Conversation

@guowenatk
Copy link
Contributor

@guowenatk guowenatk commented Dec 16, 2025

Content Description

Update vcluster platform configure section structure

Preview Link

https://deploy-preview-1499--vcluster-docs-site.netlify.app/docs/platform/next/configure/introduction

Internal Reference

Closes DOC-1107

@netlify /docs

Note

Restructures the platform configure section by splitting the monolithic config.mdx into organized subsections.

  • New structure
    • Added introduction.mdx explaining values.yaml configuration types
    • Added installation-options/overview.mdx for installation modes
    • Added platform-configs/overview.mdx for platform configuration reference
    • Added agent-settings/ directory with overview, security-context, customization, agent-upgrade, and troubleshooting pages
  • Deleted files
    • Removed config.mdx (content redistributed to new files)
    • Removed high-availability.mdx (content consolidated elsewhere)
    • Removed single-sign-on/ directory (consolidated into platform-configs/single-sign-on.mdx)
  • Updated links
    • Fixed internal references in impersonate.mdx, agent-config.mdx, preserve-license.mdx
    • Updated SSO provider partials with new import paths
    • Fixed domain.mdx references in versioned docs

Generated by Claude for commit 4425903. Updates automatically on new commits.

@guowenatk guowenatk requested a review from a team as a code owner December 16, 2025 15:09
@netlify
Copy link

netlify bot commented Dec 16, 2025

Deploy Preview for vcluster-docs-site ready!

Name Link
🔨 Latest commit 0e0988d
🔍 Latest deploy log https://app.netlify.com/projects/vcluster-docs-site/deploys/6945587ea07fe200086b6c13
😎 Deploy Preview https://deploy-preview-1499--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

@loft-bot

This comment was marked as duplicate.

@loft-bot
Copy link
Contributor

loft-bot commented Dec 18, 2025

Claude finished @guowenatk's task in 2m 5s —— View job


PR Review Summary

Remaining Issues to Fix

After reviewing the latest commit (4425903), most of the previously identified issues have been addressed. However, a few items still need attention:

Priority File Line Issue
🔴 Critical agent-upgrade.mdx 14 Missing import for GlossaryTerm component (will cause build failure)
🟡 Medium overview.mdx 38 Terminology: {} is an empty object, not "empty list"
🟡 Medium overview.mdx 70 Absolute URL path instead of relative file path
🟡 Medium saml.mdx 22 List numbering jumps from 1 to 3
🟢 Minor introduction.mdx 12 Extra space before period

What's Been Fixed Since Last Review

  • ✅ Missing imports for InterpolatedCodeBlock in security-context.mdx and overview.mdx
  • ✅ Typo "Cofigure" → "Configure" in security-context.mdx
  • ✅ British spelling "behaviour" → "behavior" across files
  • ✅ Broken anchor link #understanding-agent-values
  • ✅ Typo value:vault: in platform-configs/overview.mdx

What's Good

  • ✅ New section structure is logical and well-organized
  • ✅ Links in SSO partials use correct relative paths with .mdx extension
  • ✅ YAML code blocks have correct indentation
  • ✅ vCluster trademark used correctly throughout
  • ✅ No use of "easy", "simple", "obvious" terms

I've added inline comments with specific suggestions for each remaining issue.

@loft-bot
Copy link
Contributor

loft-bot commented Dec 19, 2025

Claude finished @guowenatk's task in 1m 14s —— View job


PR Review Summary

  • Gather context and understand PR changes
  • Read CONTRIBUTING.md for style guide
  • Review documentation files for remaining issues
  • Check additional files for issues
  • Provide summary of findings

Remaining Issues to Fix

After reviewing the latest commit (0e0988d), the critical issues from previous reviews have been addressed. However, a few minor items still need attention:

Priority File Line Issue
🟡 Medium saml.mdx 22 List numbering jumps from 1 to 3
🟡 Medium overview.mdx (agent-settings) 39 Terminology: {} is an empty object, not "empty list"
🟡 Medium overview.mdx (agent-settings) 70 Absolute URL path instead of relative file path
🟢 Minor introduction.mdx 12 Extra space before period

What's Been Fixed Since Last Review

  • ✅ Missing import for GlossaryTerm in agent-upgrade.mdx
  • ✅ Missing import for InterpolatedCodeBlock in security-context.mdx
  • ✅ Missing import for InterpolatedCodeBlock in overview.mdx
  • ✅ Typo "Cofigure" → "Configure" in security-context.mdx

What's Good

  • ✅ New section structure is logical and well-organized
  • ✅ All component imports are now present
  • ✅ Links in SSO partials use correct relative paths with .mdx extension
  • ✅ YAML code blocks have correct indentation
  • ✅ vCluster trademark used correctly throughout
  • ✅ No use of "easy", "simple", "obvious" terms

I've added inline comments with specific suggestions for each remaining issue.

1. Navigate to `Admin > Config` in the platform.
2. Adjust your configuration as shown in the example below.
1. Use the following YAML configuration to update your platform config (the `config` section of the [`values.yaml`](../../../configure/introduction.mdx)) or through vCluster Platform UI **Admin > Config**:
3. Obtain the necessary values from your SAML identity provider (IdP) for the required fields.
Copy link
Contributor

Choose a reason for hiding this comment

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

List numbering issue: Step numbers jump from 1 to 3, skipping step 2.

Suggested change
3. Obtain the necessary values from your SAML identity provider (IdP) for the required fields.
2. Obtain the necessary values from your SAML identity provider (IdP) for the required fields.


The `agentValues` behavior is as follows:
- By default, `agentValues` is an empty object `{}`.
- An empty `agentValues` list means that agents installed on connected host clusters will inherit the same configuration as the platform running on the primary host cluster.
Copy link
Contributor

Choose a reason for hiding this comment

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

Terminology: {} is an empty object in YAML/JSON, not an empty list. An empty list would be [].

Suggested change
- An empty `agentValues` list means that agents installed on connected host clusters will inherit the same configuration as the platform running on the primary host cluster.
- An empty `agentValues` object means that agents installed on connected host clusters will inherit the same configuration as the platform running on the primary host cluster.


If your kubectl context is not set to the cluster with running platform, it's
possible to login to the platform using the CLI and access key.
If you haven't already, you need to [create access key](/docs/platform/api/authentication#create-an-access-key) to be able to login to the platform.
Copy link
Contributor

Choose a reason for hiding this comment

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

Link format: Per the style guide, links should use relative file paths with .mdx extension rather than absolute URL paths.

Suggested change
If you haven't already, you need to [create access key](/docs/platform/api/authentication#create-an-access-key) to be able to login to the platform.
If you haven't already, you need to [create access key](../../api/authentication.mdx#create-an-access-key) to be able to login to the platform.

- The primary host cluster runs the vCluster Platform.
- Other host clusters connect to the primary host cluster and run the vCluster Platform Agent.
- The Platform coordinates and manages all connected host clusters through their agents.
- There are both vCluster Platform and vCluster Platform agent running on the primary host cluster . The vCluster Platform manages the primary host cluster through its vCluster Platform Agent 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.

Extra space: There's an extra space before the period.

Suggested change
- There are both vCluster Platform and vCluster Platform agent running on the primary host cluster . The vCluster Platform manages the primary host cluster through its vCluster Platform Agent as well.
- There are both vCluster Platform and vCluster Platform agent running on the primary host cluster. The vCluster Platform manages the primary host cluster through its vCluster Platform Agent as well.

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.

3 participants