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

[YUNIKORN-306] Add yunikorn rest api document #10

Merged
merged 1 commit into from Jul 28, 2020

Conversation

adamantal
Copy link

Work done:

  • added a new dropdown menu to the site ("API Documentation")
  • added three pages: Cluster, Scheduler and System that list all the available endpoints from scheduler/routes.go grouping them by first path item
  • used https://github.com/jamescooke/restapidocs for formatting, but I'm open to any suggestions if you have some problems

The examples are extracted via a locally running running a YK scheduler instance, and crawling the 9080 port on my laptop.

@yangwwei yangwwei assigned yangwwei and adamantal and unassigned yangwwei Jul 28, 2020
@yangwwei yangwwei added the documentation Improvements or additions to documentation label Jul 28, 2020
@yangwwei
Copy link
Contributor

hi @adamantal thanks for the patch, it looks pretty good.
I only have one minor comment about adjusting the sidebar order, but that can be done in a separate JIRA. Thanks!

@yangwwei yangwwei merged commit 69aff17 into apache:master Jul 28, 2020
@adamantal adamantal deleted the YUNIKORN-306 branch July 29, 2020 08:36
@adamantal
Copy link
Author

Let me file a jira for that. What is your suggestion regarding the order?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
2 participants