Neil Conway created MESOS-5612:
----------------------------------

             Summary: Improve formatting, consistency of Mesos endpoint docs
                 Key: MESOS-5612
                 URL: https://issues.apache.org/jira/browse/MESOS-5612
             Project: Mesos
          Issue Type: Documentation
          Components: documentation
            Reporter: Neil Conway


Things to improve:

* Separate "Input", "Output" sections described expected input and output 
formats
* Use Markdown formatting for lists, when appropriate (e.g., lists of possible 
HTTP status codes, using backticks where appropriate)
* Add more examples, especially of legal inputs
* Replace "TL;DR" with "Summary"
* Links from endpoint docs to regular docs?



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to