docs: update ro docs #1037
Open
docs: update ro docs #1037
Conversation
This file contains 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
jwtty
reviewed
Feb 10, 2025
Comment on lines
+165
to
+190
| To delete the `my-deployment` on the clusters with the label `env: test` selected by the clusterResourcePlacement `crp-example`, | ||
| you can use the `Delete` override type. | ||
| ```yaml | ||
| apiVersion: placement.kubernetes-fleet.io/v1alpha1 | ||
| kind: ResourceOverride | ||
| metadata: | ||
| name: example-ro | ||
| namespace: test-namespace | ||
| spec: | ||
| placement: | ||
| name: crp-example | ||
| resourceSelectors: | ||
| - group: apps | ||
| kind: Deployment | ||
| version: v1 | ||
| name: my-deployment | ||
| policy: | ||
| overrideRules: | ||
| - clusterSelector: | ||
| clusterSelectorTerms: | ||
| - labelSelector: | ||
| matchLabels: | ||
| env: test | ||
| overrideType: Delete | ||
| ``` | ||
|
|
There was a problem hiding this comment.
why not move this example into the Override Type section?
There was a problem hiding this comment.
or move the OverrideType section earlier or remove it? Ideally, the OverrideType section should be the parent of JSON Patch Override and have a delete type section. Currently, it's at the same level as JSON Patch and no corresponding Delete section.
There was a problem hiding this comment.
i think the current logic is to give concrete examples at the very beginning of the policy section, and then go deep into each field. it should be ok?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of your changes
update the ro how-to docs to include new features
Fixes #
I have:
make reviewableto ensure this PR is ready for review.How has this code been tested
Special notes for your reviewer