[GitHub] [yunikorn-site] craigcondit edited a comment on pull request #149: Document changes from YUNIKORN-1087

[GitBox <gi...@apache.org>]

craigcondit edited a comment on pull request #149:
URL: https://github.com/apache/yunikorn-site/pull/149#issuecomment-1085028105


   > What would be a good area in the docs, if any, to explain the definitions of the newly added keys? Didn't seem appropriate to specifically include info about `allocationDelay` or `placeholderUsed` in the file I modified, since fine-grain info about allocations would be secondary relative to their documented REST endpoint -- `/apps` or `/nodes`.
   
   > There's a little bit of nuance I'd like to clarify, as the meaning of `requestTime` and therefore `allocationDelay` can change based on the value of `placeholderUsed` as discussed [here](https://issues.apache.org/jira/browse/YUNIKORN-1087)
   
   I think this could probably be done in the REST API docs on the website. There's space right before the example for each endpoint where you could call out the meaning of some of the fields. Alternatively, it could go in the Overview section at the top:
   <img width="661" alt="overview" src="https://user-images.githubusercontent.com/12699633/161136691-3d39a108-7863-455b-9fc0-e5f86636042b.png">
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org