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 API reference documentation on the website #472

Closed
3 of 6 tasks
Affan-7 opened this issue Sep 20, 2023 · 4 comments
Closed
3 of 6 tasks

Add API reference documentation on the website #472

Affan-7 opened this issue Sep 20, 2023 · 4 comments
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.

Comments

@Affan-7
Copy link
Member

Affan-7 commented Sep 20, 2023

What documentation would you like to be added:
API documentation
Related to: karmada-io/karmada#3843

Why do you think this document is needed:
API reference documentation is helpful to understand the karmada APIs better.

Where do you think the document should be placed:
I think the document could be placed under /docs/reference/api-reference/

  • Select a tool for generating docs (bootprint)

  • Create a prototype of API docs (API docs prototype #471)

  • Fix the broken CSS

  • Generate the splitted swagger json based on the API groups

  • Generate the API docs based on the API groups

  • Add API docs to the production

@Affan-7 Affan-7 added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Sep 20, 2023
@RainbowMango
Copy link
Member

Just looked at the bootprint, seems it has been moved to bootprint-monorepo, that's ok, but the concerning thing is it no activities since Apr 11, 2020
.
What do you think of it?

@XiShanYongYe-Chang
Copy link
Member

Hi @Affan-7, it seems that we have finished this task, how about close this issue?

@Affan-7
Copy link
Member Author

Affan-7 commented Oct 8, 2023

Oh I forgot to close this.

@Affan-7 Affan-7 closed this as completed Oct 8, 2023
@XiShanYongYe-Chang
Copy link
Member

Thanks, Affan~

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
Projects
None yet
Development

No branches or pull requests

3 participants