Skip to content

Conversation

@zerbitx
Copy link
Contributor

@zerbitx zerbitx commented Dec 12, 2025

Clarify distinction between with and without agent.

Content Description

Preview Link

Internal Reference

Closes DOC-1013
Closes DOC-1063

@netlify /docs

Note

Clarifies the distinction between vCluster sleep mode with and without a platform agent, adds Istio gateway support for activity detection.

  • Sleep mode configuration (sleep-mode.mdx)
    • Added detailed comparison of sleep mode behavior with vs without platform agent
    • Added comparison table showing key differences (control plane state, resource savings, auto-deletion)
    • Improved "Connect to the platform" section explaining agent takeover of sleep mode
    • Added control plane behavior tips for deployment configuration
    • Minor formatting fixes (removed backticks from inline code in prose)
  • Sleep and wakeup (sleep-wakeup.mdx)
    • Added new "Manual vs automatic sleep mode" section to clarify the two approaches
    • Added "What happens during manual sleep" and "Differences from automatic sleep mode" sections
    • Added "When to use manual vs automatic sleep mode" guidance section
    • Grammar fix: "needs" → "need" for subject-verb agreement
  • Activity detection partial (activity-detection.mdx)
    • Added Istio Gateways with Virtual Services to supported activity detection methods
    • Added explanation of how VirtualServices are modified during sleep/wake

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

@netlify
Copy link

netlify bot commented Dec 12, 2025

Deploy Preview for vcluster-docs-site ready!

Name Link
🔨 Latest commit e905fb4
🔍 Latest deploy log https://app.netlify.com/projects/vcluster-docs-site/deploys/694358a75b9d2e00080af203
😎 Deploy Preview https://deploy-preview-1491--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
Copy link
Contributor

Review complete for e4132e9 - 1 issue flagged as inline comment.

E2E tests: Skipped - changes are text clarifications and documentation restructuring with no mermaid diagrams, test files, or significant structural changes that would require visual verification.

Clarify distinction between with and without agent.

Signed-off-by: Ryan Swanson <[email protected]>
@github-actions
Copy link
Contributor

Review complete for ca9eef8 - no issues found.

E2E tests: Skipped - changes are text clarifications, documentation restructuring, and added Istio information. No mermaid diagrams, test files, or significant structural changes that would require visual verification.

@zerbitx zerbitx marked this pull request as ready for review December 12, 2025 20:51
@zerbitx zerbitx requested a review from a team as a code owner December 12, 2025 20:51
Piotr1215

This comment was marked as duplicate.

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.

LGTM, a few small changes required

@loft-bot
Copy link
Contributor

Review for e905fb4

Files reviewed: 6 files (all DOCS)

  • platform/_partials/sleep/activity-detection.mdx
  • platform_versioned_docs/version-4.3.0/_partials/sleep/activity-detection.mdx
  • platform_versioned_docs/version-4.4.0/_partials/sleep/activity-detection.mdx
  • platform_versioned_docs/version-4.5.0/_partials/sleep/activity-detection.mdx
  • vcluster/configure/vcluster-yaml/sleep-mode.mdx
  • vcluster/manage/sleep-wakeup.mdx

Findings

Issues Found

  1. vcluster/configure/vcluster-yaml/sleep-mode.mdx:210 & 217 - Duplicated paragraph:
    The sentence "This setup allows the virtual cluster to reduce resource usage while still being able to monitor activity and trigger wake-up actions when needed." appears twice - once at line 210 and again at line 217. The first occurrence should be removed as it appears before the admonition and is duplicated immediately after it.

  2. vcluster/configure/vcluster-yaml/sleep-mode.mdx:23 - Link uses URL path instead of relative file path:
    /vcluster/configure/vcluster-yaml/sleep-mode should use relative path with .mdx extension per style guide. However, since this is a self-reference within the same file (the link points to the file itself), this could be simplified or removed.

  3. vcluster/manage/sleep-wakeup.mdx:23 - Link uses URL path instead of relative file path:
    /vcluster/configure/vcluster-yaml/sleep-mode should use a relative file path like ../configure/vcluster-yaml/sleep-mode.mdx

  4. vcluster/manage/sleep-wakeup.mdx:72, 119 - Same URL path link issue as above.

  5. vcluster/configure/vcluster-yaml/sleep-mode.mdx:166 - Grammatically awkward sentence:
    "In version 0.24.x, the autoDelete configuration is still under external.platform and is set to move under sleepMode in a later release. external.platform to be moved under sleepMode in a future release."
    The second sentence is incomplete/fragmented.

Style Guide Compliance Verified

  • ✅ Sentence case used correctly in headings
  • ✅ Present tense and active voice used throughout
  • ✅ No usage of "easy", "simple", "obvious"
  • ✅ vCluster trademark used correctly (never pluralized as "vClusters")
  • ✅ YAML code blocks have correct indentation
  • ✅ No admonitions inside JSX components like <Step>
  • ✅ External links to GitHub and Istio are properly formatted with markdown syntax

Content Improvements Noted

  • Good: Added Istio support documentation to activity detection
  • Good: Clarified the difference between "with agent" and "without agent" sleep mode
  • Good: Added new table comparing features with and without agent
  • Good: Improved the sleep-wakeup.mdx page to clearly differentiate manual vs automatic sleep
  • Good: Consistent terminology change from "vCluster" to "virtual cluster instance" where referring to instances
  • Good: Removed stale/unused Mermaid class definitions that weren't rendering

Checklist verified

  • Links use relative file paths with .mdx extension - ISSUE: URL paths used in 4 locations
  • YAML code blocks have correct indentation
  • Admonitions (:::note, :::warning) are not inside JSX components
  • Sentence case for headings
  • Present tense, active voice
  • No "easy", "simple", "obvious" words
  • vCluster trademark used correctly (never "vClusters")
  • No hardcoded secrets or credentials
  • Syntax is valid

@loft-sh loft-sh deleted a comment from loft-bot Dec 18, 2025
@zerbitx zerbitx requested a review from Piotr1215 December 18, 2025 01:36
@github-actions
Copy link
Contributor

@Piotr1215 Piotr1215 merged commit 9c073cf into main Dec 18, 2025
12 checks passed
@Piotr1215 Piotr1215 deleted the DOC-1013-and-1063 branch December 18, 2025 15:18
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.

4 participants