API docs generated by reference-docs

[greensong]

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Add API documents.

If you want to generate API documents, you can do like this:

1. In the api and config directories within reference-docs, create folders named with version numbers to store the new versions of swagger.json and toc.yaml files respectively.
2. Run the following commands to generate the docs:

#!/bin/bash

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

# Generate API documents
# Please note, replace `v1.0` with your own version number.
make VERSION=v1.0

# Delete all the carriage returns (CR)
sed -i 's/\r//g' `find kwebsite -name "*.md"`
# Remove the redundant line feeds (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

[kubeedge-bot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign dingyin after the PR has been reviewed.
You can assign the PR to them by writing /assign @dingyin 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:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[kubeedge-bot]

Welcome @greensong! It looks like this is your first PR to kubeedge/website 🎉

[Shelley-BaoYue]

It seems actually no APIs in other resources dir, we can remove this directory.

[greensong]

Processed

[Shelley-BaoYue]

operations still have another API: nodeUpgradeJob Ref: https://github.com/kubeedge/kubeedge/blob/master/pkg/apis/operations/v1alpha1/type.go

[greensong]

we added this API(nodeUpgradeJob):https://github.com/greensong/website/blob/master/docs/reference/kubeedge-api/operations-resources/node-upgrade-job-v1alpha1.md

[Shelley-BaoYue]

We can add a category file under every directory like https://github.com/kubeedge/website/blob/master/docs/architecture/edge/_category_.json, name this directory with Reference, KubeEdge API and Apps Resources.

[Shelley-BaoYue]

Sorry, I cannot find where are the common parameters from, could you help figure it out? Another optimization idea about common parameters: Now metadata details are described in every API file, autually these all seem to be the same, we can put metadata under common parameters.
Ref: https://karmada.io/docs/reference/karmada-api/common-definitions/object-meta#objectmeta

[Shelley-BaoYue]

Could you please introduce how these API files auto-generated step-by-step? including, but not limited to, the reference repository (now is your personal repo), what modified you have did in the repo, and how to use it. And we can also explore how to generate the Chinese version of the API documentation in the future.

[greensong]

We've made changes to the revisions,If there are areas for improvement, we will continue to make changes.