docs(doc-1576): add patching reference page for sync resources#2335
Open
djwfyi wants to merge 4 commits into
Open
docs(doc-1576): add patching reference page for sync resources#2335djwfyi wants to merge 4 commits into
djwfyi wants to merge 4 commits into
Conversation
new patching section covering path syntax, expression/reference/labels modes, supported resources tables with fromHost keyword guidance, validation rules, and troubleshooting. fixes broken patching links across 22 resource pages that were missing the README.mdx suffix. Closes DOC-1576 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
adds 11 missing fromHost resources to the supported resources table, corrects the gateways link to point to the fromHost page, and replaces the mermaid diagram with an svg showing expression/reverseExpression directionality. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
✅ Deploy Preview for vcluster-docs-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
the prose and supported resources tables already cover the config key paths; the empty patches example added no additional value. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| Choose the mode based on what the field contains: | ||
|
|
||
| | When you need to transform ... | Use | |
Contributor
There was a problem hiding this comment.
[Google.Ellipses] In general, don't use an ellipsis.
| | [Storage Classes](../from-host/storage-classes.mdx) | `sync.fromHost.storageClasses.patches` | `expression` | | ||
| | Volume Snapshot Classes | `sync.fromHost.volumeSnapshotClasses.patches` | `expression` | | ||
|
|
||
| ## Troubleshooting |
Contributor
There was a problem hiding this comment.
[Loft.imperative-headings] Headings should start with an imperative verb. 'Troubleshooting' appears to be a present participle (ends with 'ing').
| ## Resources available to sync from control plane cluster to tenant cluster | ||
| <SyncFromHostResources/> | ||
|
|
||
| ## Patching synced resources |
Contributor
There was a problem hiding this comment.
[Loft.imperative-headings] Headings should start with an imperative verb. 'Patching' appears to be a present participle (ends with 'ing').
Contributor
|
|
||
| Choose the mode based on what the field contains: | ||
|
|
||
| | When you need to transform ... | Use | |
Contributor
There was a problem hiding this comment.
[Google.Ellipses] In general, don't use an ellipsis.
| | [Storage Classes](../from-host/storage-classes.mdx) | `sync.fromHost.storageClasses.patches` | `expression` | | ||
| | Volume Snapshot Classes | `sync.fromHost.volumeSnapshotClasses.patches` | `expression` | | ||
|
|
||
| ## Troubleshooting |
Contributor
There was a problem hiding this comment.
[Loft.imperative-headings] Headings should start with an imperative verb. 'Troubleshooting' appears to be a present participle (ends with 'ing').
surfaces the expression/reverseExpression rule for fromHost resources earlier in the expression patches section, and expands the fromHost table lead-in to explain why configmaps, secrets, and custom resources are exceptions to the expected direction model. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Content Description
New
/configure/vcluster-yaml/sync/patchingreference page documenting sync patch configuration. Covers path syntax (dot notation, bracket notation, wildcards, empty paths), patch modes (expression, reference, labels), directionality for toHost and fromHost resources, validation rules, and a troubleshooting table. Includes an SVG diagram showing the expression/reverseExpression flow.Also fixes broken patching links across 22 existing resource pages — all were missing the
README.mdxsuffix, causing silent 404s on click.Preview Link
https://deploy-preview-2335--vcluster-docs-site.netlify.app/docs/vcluster/next/configure/vcluster-yaml/sync/patching
Internal Reference
Closes DOC-1576
AI review: mention
@claudein a comment to request a review or changes. See CONTRIBUTING.md for available commands.@netlify /docs