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

fix karmada-api folder docs for MDX3 #565

Closed
wants to merge 1 commit into from
Closed

fix karmada-api folder docs for MDX3 #565

wants to merge 1 commit into from

Conversation

Arhell
Copy link
Member

@Arhell Arhell commented Feb 8, 2024

What type of PR is this?

Add one of the following kinds:

/kind bug
/kind cleanup
/kind documentation

What this PR does / why we need it:

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

@karmada-bot karmada-bot added the kind/bug Categorizes issue or PR as related to a bug. label Feb 8, 2024
@karmada-bot karmada-bot requested review from Poor12 and Tingtal February 8, 2024 23:02
@karmada-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign rainbowmango after the PR has been reviewed.
You can assign the PR to them by writing /assign @rainbowmango in a comment when ready.

The full list of commands accepted by this bot can be found 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 kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 8, 2024
Arhell
Arhell commented Feb 10, 2024
View reviewed changes
Copy link
Member Author

@Arhell Arhell left a comment

Choose a reason for hiding this comment

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

@RainbowMango

RainbowMango
RainbowMango reviewed Feb 17, 2024
View reviewed changes
docs/reference/karmada-api/auto-scaling-resources/cron-federated-hpa-v1alpha1.md
@@ -222,7 +222,7 @@ CronFederatedHPAList contains a list of CronFederatedHPA.

#### HTTP Request

GET /apis/autoscaling.karmada.io/v1alpha1/namespaces/{namespace}/cronfederatedhpas/{name}
GET /apis/autoscaling.karmada.io/v1alpha1/namespaces/\{namespace\}/cronfederatedhpas/\{name\}
Copy link
Member

Choose a reason for hiding this comment

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

Given tools generate these docs, I don't know if we can update them manually.
cc tools author here for comments. @chaosi-zju

@Arhell
Copy link
Member Author

Arhell commented Feb 17, 2024

@RainbowMango
Please tell me which folders are generated, so that I can update those documents that are not generated and then think about what to do next.

@RainbowMango
Copy link
Member

Files under docs/reference are almost auto-generated, except:

  • docs/reference/instrumentation
  • docs/reference/glossary.md
  • docs/reference/object-association-mapping.md
  • docs/reference/reserved-namespaces.md

@Arhell Arhell closed this Feb 18, 2024
@Arhell Arhell deleted the upd branch February 18, 2024 01:24
@Arhell Arhell mentioned this pull request Mar 7, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RainbowMango RainbowMango RainbowMango left review comments

@Poor12 Poor12 Awaiting requested review from Poor12

@Tingtal Tingtal Awaiting requested review from Tingtal

Assignees
No one assigned
Labels
kind/bug Categorizes issue or PR as related to a bug. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Arhell @karmada-bot @RainbowMango