Skip to content

update toc.yaml #1015

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

Merged
karmada-bot merged 1 commit into from
May 26, 2026
Merged

update toc.yaml #1015

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions infra/gen-resourcesdocs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,9 @@ For each definition (including resources, which are definitions attached to a Gr

### Script

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

@gemini-code-assist gemini-code-assist Bot May 26, 2026

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:

```shell
$ hack/reference-api.sh
```

It will pull the latest `swagger.json` from the Karmada repo, use the `hack/extract-toc.sh` script to extract Karmada API resources from `swagger.json` and update them to `config/current/toc.yaml`, and finally generate the Karmada API resources documentation.
24 changes: 12 additions & 12 deletions infra/gen-resourcesdocs/config/current/toc.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
parts:
- name: App Resources
- name: Apps Resources
chapters:
- name: WorkloadRebalancer
group: "apps.karmada.io"
version: v1alpha1
- name: AutoScaling Resources
- name: Autoscaling Resources
chapters:
- name: FederatedHPA
- name: CronFederatedHPA
group: "autoscaling.karmada.io"
version: v1alpha1
- name: CronFederatedHPA
- name: FederatedHPA
group: "autoscaling.karmada.io"
version: v1alpha1
- name: Cluster Resources
Expand All @@ -35,22 +35,22 @@ parts:
version: v1alpha1
- name: Policy Resources
chapters:
- name: FederatedResourceQuota
- name: ClusterOverridePolicy
group: "policy.karmada.io"
version: v1alpha1
- name: OverridePolicy
- name: ClusterPropagationPolicy
group: "policy.karmada.io"
version: v1alpha1
- name: ClusterOverridePolicy
- name: ClusterTaintPolicy
group: "policy.karmada.io"
version: v1alpha1
- name: PropagationPolicy
- name: FederatedResourceQuota
group: "policy.karmada.io"
version: v1alpha1
- name: ClusterPropagationPolicy
- name: OverridePolicy
group: "policy.karmada.io"
version: v1alpha1
- name: ClusterTaintPolicy
- name: PropagationPolicy
group: "policy.karmada.io"
version: v1alpha1
- name: Remedy Resources
Expand All @@ -68,10 +68,10 @@ parts:
- name: Work
group: "work.karmada.io"
version: v1alpha1
- name: ResourceBinding
- name: ClusterResourceBinding
group: "work.karmada.io"
version: v1alpha2
- name: ClusterResourceBinding
- name: ResourceBinding
group: "work.karmada.io"
version: v1alpha2
- name: Common Definitions
Expand Down
Loading