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.

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

add Karmada API Document for v1.9 #573

Merged
merged 1 commit into from
Mar 6, 2024
Merged

Conversation

chaosi-zju
Copy link
Member

@chaosi-zju chaosi-zju commented Mar 4, 2024

What type of PR is this?

/kind documentation

What this PR does / why we need it:

add Karmada API Document for v1.9

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

quick click

If you want to generate api document, you can do like this:

  1. update [api/current/swagger.json] and [config/current/toc.yaml] in reference-docs.

  2. run following commands to generate the doc:

#!/bin/bash

git clone https://github.com/chaosi-zju/reference-docs.git
cd reference-docs || exit 1

# generate api document
make

# delete all the carriage Return (CR)
sed -i 's/\r//g' `find kwebsite -name "*.md"`
# remove the redundant linefeed (LF)
sed -i '/^$/N;/^\n$/D' `find kwebsite -name "*.md"`

# move the generated docs to Docusaurus doc path
rm -rf ../docs/reference/api-documents
mv -f kwebsite/content/en/docs ../docs/reference/api-documents
cd .. && rm -rf reference-docs
  1. git add/commit/push

@karmada-bot karmada-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Mar 4, 2024
@karmada-bot karmada-bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Mar 4, 2024
@RainbowMango
Copy link
Member

Is this doc generated based on karmada-io/karmada#4675?

Please update the documents of v1.9, not only the current version.

@chaosi-zju
Copy link
Member Author

Is this doc generated based on karmada-io/karmada#4675?

Yes.

Please update the documents of v1.9, not only the current version.

done.

@karmada-bot karmada-bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Mar 6, 2024
Copy link
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 Mar 6, 2024
@karmada-bot
Copy link
Collaborator

[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

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 Mar 6, 2024
@karmada-bot karmada-bot merged commit 45af53f into karmada-io:main Mar 6, 2024
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/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants