Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: update Recommended usage conventions for karmadactl, and fix a t… #353

Merged
merged 1 commit into from
May 4, 2023
Merged

doc: update Recommended usage conventions for karmadactl, and fix a t… #353

merged 1 commit into from
May 4, 2023

Conversation

yike21
Copy link
Member

@yike21 yike21 commented May 2, 2023

…ypo in configure-controllers document

What type of PR is this?
/kind documentation

What this PR does / why we need it:
If the documents are updated, users can more easily find the karmadactl interpret --operation ReviseReplica section.

Which issue(s) this PR fixes:
Fixes #347
Fixes #3401

Special notes for your reviewer:
@Poor12

@karmada-bot karmada-bot added the kind/documentation Categorizes issue or PR as related to documentation. label May 2, 2023
@karmada-bot
Copy link
Collaborator

Welcome @yike21! It looks like this is your first PR to karmada-io/website 🎉

@karmada-bot karmada-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 2, 2023
@yike21
Copy link
Member Author

yike21 commented May 2, 2023

Note that karmadactl needs to be based on the latest kube library.

Poor12
Poor12 reviewed May 4, 2023
View reviewed changes
...saurus-plugin-content-docs/version-v1.5/reference/karmadactl/karmadactl-usage-conventions.md Outdated
@@ -137,22 +137,9 @@ spec:
end
dependencyInterpretation:
luaScript: >
local kube = require("kube")
Copy link
Member

Choose a reason for hiding this comment

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

For such enhanced changes, I think only the current version needs to be changed.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, it's more reasonable.

...saurus-plugin-content-docs/version-v1.5/reference/karmadactl/karmadactl-usage-conventions.md
@@ -202,6 +189,12 @@ karmadactl interpret -f resourceinterpretercustomization.yaml --observed-file ob
karmadactl interpret -f resourceinterpretercustomization.yaml --desired-file desired-deploy-nginx.yaml --observed-file observed-deploy-nginx.yaml --operation Retain
```

#### 执行 ReviseReplica 规则
Copy link
Member

Choose a reason for hiding this comment

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

Do we need to apply this change in version-1.4?

Copy link
Member Author

@yike21 yike21 May 4, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

V1.4.0 was released on November 30, 2022, and pkg/karmadactl/interpret/interpret.go had the full functionality of karmadactl interpret on November 28, 2022. Chronologically, I think the documentation can be updated.

@karmada-bot karmada-bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 4, 2023
@yike21
doc: update Recommended usage conventions for karmadactl, and fix a t…
4925bc0 
…ypo in configure-controllers document

Signed-off-by: yike21 <yike21@qq.com>
@karmada-bot karmada-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 4, 2023
@Poor12
Copy link
Member

Poor12 commented May 4, 2023

/lgtm

@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label May 4, 2023
RainbowMango
RainbowMango approved these changes May 4, 2023
View reviewed changes
Copy link
Member

@RainbowMango RainbowMango left a comment

Choose a reason for hiding this comment

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

/approve

@karmada-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: RainbowMango

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@karmada-bot karmada-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 4, 2023
@karmada-bot karmada-bot merged commit 579dc62 into karmada-io:main May 4, 2023
@yike21 yike21 deleted the doc-update branch May 4, 2023 07:11
@yike21 yike21 mentioned this pull request Jun 4, 2023
Closed
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Poor12 Poor12 Poor12 left review comments

@RainbowMango RainbowMango RainbowMango approved these changes

@pigletfly pigletfly Awaiting requested review from pigletfly

@Tingtal Tingtal Awaiting requested review from Tingtal

Assignees

@Poor12 Poor12

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
4 participants
@yike21 @karmada-bot @Poor12 @RainbowMango