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-746: Simplify the REST API document #64
Conversation
hi @manirajv06 thanks for working on this. Can we remove the "Deprecated" and "Newer version" in the doc, and merge them into one section? For queus/apps/nodes, we should only have one section each, and the old/new API can all be explained in each single section. |
Taken care. Pls check. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, it looks much better. I just added some minor comments to request the change of sub-titles, hope that makes sense.
docs/api/scheduler.md
Outdated
## Queues (Newer Version) | ||
## Queues | ||
|
||
### Single Partition |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Partition queues
docs/api/scheduler.md
Outdated
@@ -162,7 +164,7 @@ For the default queue hierarchy (only `root.default` leaf queue exists) a simila | |||
} | |||
``` | |||
|
|||
## Queues | |||
### All Partitions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All queues
docs/api/scheduler.md
Outdated
## Applications (Newer Version) | ||
## Applications | ||
|
||
### Single Partition |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Queue applications
docs/api/scheduler.md
Outdated
@@ -319,7 +323,7 @@ In the example below there are three allocations belonging to two applications. | |||
} | |||
``` | |||
|
|||
## Applications | |||
### All Partitions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All applications
docs/api/scheduler.md
Outdated
## Nodes (Newer Version) | ||
## Nodes | ||
|
||
### Single Partition |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Partition nodes
docs/api/scheduler.md
Outdated
@@ -508,7 +514,7 @@ Here you can see an example response from a 2-node cluster having 3 allocations. | |||
} | |||
``` | |||
|
|||
## Nodes | |||
### All Partitions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All nodes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Doc changes to clearly explain the Old and Newer version API's use.