Skip to content

update toc.yaml#1015

Merged
karmada-bot merged 1 commit into
karmada-io:mainfrom
zhzhuang-zju:toc
May 26, 2026
Merged

update toc.yaml#1015
karmada-bot merged 1 commit into
karmada-io:mainfrom
zhzhuang-zju:toc

Conversation

@zhzhuang-zju
Copy link
Copy Markdown
Contributor

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:

Signed-off-by: zhzhuang-zju <m17799853869@163.com>
@karmada-bot karmada-bot added the kind/documentation Categorizes issue or PR as related to documentation. label May 26, 2026
@karmada-bot karmada-bot requested review from Poor12 and pigletfly May 26, 2026 07:58
@karmada-bot karmada-bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 26, 2026
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

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:
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

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").

Suggested change
Generate the Karmada latest API resources documentation by running the following script:
Generate the latest Karmada API resources documentation by running the following script:

Copy link
Copy Markdown
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.

/lgtm
/approve

@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label May 26, 2026
@karmada-bot
Copy link
Copy Markdown
Contributor

[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

Details 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 26, 2026
@karmada-bot karmada-bot merged commit 026f1cf into karmada-io:main May 26, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants