update toc.yaml#1015
Conversation
Signed-off-by: zhzhuang-zju <m17799853869@163.com>
There was a problem hiding this comment.
Code Review
This pull request updates the README.md and the toc.yaml configuration file for generating Karmada API resources documentation. The changes clarify the script's execution process and update resource category names and sorting. The reviewer suggested improving the phrasing in the README.md to "latest Karmada API resources" and pointed out that other example blocks in the README are now out of sync with the updated toc.yaml structure and should be updated for consistency.
|
|
||
| 1. update the `config/current/toc.yaml` file according to the latest Karmada API resources. | ||
| 2. generate the Karmada latest API resources documentation by running the following script: | ||
| Generate the Karmada latest API resources documentation by running the following script: |
There was a problem hiding this comment.
The phrasing "Karmada latest API resources" is slightly awkward. It would be more natural to say "latest Karmada API resources". Additionally, the example configuration block (lines 17-30) and the explanation text (line 32) in this README are now out of sync with the updated toc.yaml format and sorting. Please update them to maintain consistency (e.g., updating "App Resources" to "Apps Resources", "AutoScaling Resources" to "Autoscaling Resources", sorting the chapters, and fixing the typos "ont chapters" to "one chapter" and "two chapter" to "two chapters").
| Generate the Karmada latest API resources documentation by running the following script: | |
| Generate the latest Karmada API resources documentation by running the following script: |
|
[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 DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What type of PR is this?
/kind documentation
What this PR does / why we need it:
A follow-up task of #1010
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer: