update karmadactl promote doc#996
Conversation
karmada-bot
added
the
kind/documentation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
karmada-bot
added
the
size/S
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates documentation for the karmadactl promote command and related migration guides to improve grammar, clarity, and consistency. The review highlights that some of these files are auto-generated, suggesting that changes should be applied to the source code rather than the generated documentation. Additionally, feedback was provided to further refine the technical accuracy of the API server comparison and to ensure proper translation and consistency in the documentation.
Signed-off-by: Tessa Pham <hpham111@bloomberg.net>
tessapham
force-pushed
the
update-karmadactl-doc
branch
from
89fef58 to
811d94a
Compare
|
karmada-io/karmada#7391 to update the auto-generated description from source. |
| --- | ||
|
|
||
| Promote resources from legacy clusters to Karmada control plane | ||
| Promote resources from legacy clusters to Karmada control plane. |
There was a problem hiding this comment.
Hi @tessapham, thank you for the corrections you’ve made!
I have a small point to note: the files under the reference directory are automatically generated from the code in the Karmada repo. For details, you can refer to:
https://karmada.io/docs/developers/document-releasing#update-reference-documentsmanually
Therefore, our usual practice is to modify the code in the Karmada repo first, then sync the changes to the website repo.
I noticed that some changes in karmadactl_promote.md are not covered by karmada-io/karmada#7391, so they will be overwritten in the next automatic synchronization.
It is recommended that you either remove these uncovered changes, or make the modifications in the Karmada repo and then sync them to the website repo.
There was a problem hiding this comment.
Sorry, I missed your comment #996 (comment) before, but there are still some uncovered changes from the source. Please take a look.
There was a problem hiding this comment.
Thanks @zhzhuang-zju for reviewing – I'll revise this PR! Curious - is there a script to run to sync the changes from the source repo to the website repo?
There was a problem hiding this comment.
Yeah, good question! Not yet; we need to manually run the tools to sync.
There was a problem hiding this comment.
Hey Tessa, yes, here is the doc for releasing the documentation: https://karmada.io/docs/developers/document-releasing.
By the way, I appreciate your effort on this. Please feel free to open PRs once you have found anything needed.
There was a problem hiding this comment.
is there a script to run to sync the changes from the source repo to the website repo?
I think we’ll have one soon. #1010 will automate the corresponding process.
|
The CI |
4 participants
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Rewordings.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer: