Skip to content

Apply fixes for eleven open documentation issues from the source repo - #29

Open
jasnoyaeger wants to merge 10 commits into
devfrom
easy-docs-issue-batch
Open

Apply fixes for eleven open documentation issues from the source repo#29
jasnoyaeger wants to merge 10 commits into
devfrom
easy-docs-issue-batch

Conversation

@jasnoyaeger

@jasnoyaeger jasnoyaeger commented Aug 3, 2026

Copy link
Copy Markdown
Member

Applies the well-specified fixes from open issues on verge-io/docs to the GitBook site. One batch, one file set per issue:

Reviewer notes — deviations from the issue text

  • #476: The issue's table claimed a whole-system sync allows recovery of the "whole system only." That contradicts our published KB (Recovering a Single VM from a Remote System Snapshot), which documents per-VM recovery from a received system snapshot. I reframed the distinction around tenant workloads: tenants replicate as single objects, so per-VM recovery inside a tenant needs tenant-to-tenant sync. Please confirm this framing.
  • #474: The 87600-hour (10-year) field cap and its validation error come from support knowledge and were flagged in the issue as not lab-tested.
  • #473: Adjusted the issue's menu paths to match the rest of our docs (System > System Snapshots, Backup/DR > Outgoing Syncs; the issue said "System > Cloud Snapshots" and "System > Site Syncs > Outgoing").
  • Removed the stale "Document Information" footers from the two KB articles touched, per current convention.

Cross-space link check passes (399 occurrences, 0 bad). No MkDocs syntax remains in changed files.

🤖 Generated with Claude Code

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
We will make an effort to avoid this type of wording in doc, which has a negative context
Updated text for clarity and consistency regarding SMART max hours and drive health warnings - hdd vs ssd
Updated the documentation for immutable snapshots to enhance clarity and provide additional details on key points, best practices, and operational guidelines.
Clarified points regarding immutable snapshots, including deletion restrictions and retention periods. Updated language for better clarity on capacity planning and response windows.
Changed the hint about adding a user's group membership that pointed to the add member instructions - which would involve going to each group individually.  It would be more efficient, typically, to use the modify membership menu option to simply select all the groups at once for the user.
Updated the section on recovery granularity to clarify sync options and their implications for disaster recovery.  Existing explanation might be confusing to users unfamiliar with the system ( "how do i select tenant level sync"? or the assumption that doing a partial system snapshot with only tenants selected is a "tenant-level sync") Additionally, we don't want to leave the impression that a top-level admin inherently has permissions to configure a tenant-to-tenant level site sync and access the tenant's VMs and other objects without having tenant credentials.
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