I really like the idea! With regards to the grouping - I think I can help and attached is a file. The "xe help --all" command groups all 417+ commands into their logical order. With each release, I have a simple Perl script that extracts this so I can inject it into a Word Document for sharing, knowledge, and my "aging brain".
With regards to the API, I would really like to see examples - based on the SDK and third-party code supported - to give an example of how each call could be used. That may take some time, but would definitely be worth the effort in the long run. Sincerely, Jesse Benedict, CCSP, CCA | Sr. Technical Support (10:00 – 19:00 EST) | Citrix Systems, Inc. -----Original Message----- From: xs-devel-requ...@lists.xenserver.org [mailto:xs-devel-requ...@lists.xenserver.org] On Behalf Of Dave Scott Sent: Tuesday, January 27, 2015 4:03 PM To: xen-...@lists.xenproject.org Cc: xs-devel Subject: [xs-devel] improving the XenAPI docs Hi, I’ve been thinking about how to improve the XenAPI reference[1]. The things I like about the reference are: - it’s generated from the IDL, so it’s always up to date - it’s got everything in it The things I don’t like about the reference are: - it’s got everything in it… in alphabetical order, rather than in any kind of usefulness order - the descriptions of fields/ functions are… terse (and often tautologous) - there are no in-line examples I’d like to improve the reference by making 2 extensions: 1. I’d like to add tags to each field and function, and allow the docs to be searched by tag (e.g. find all the fields and functions related to “snapshots”) A well-known tag name would be “core” meaning “stuff you need to know” and I propose we either filter for that by default, or at least re-order the elements so we have core first. 2. I’d like to create a sparse file overlay per-API in the xen-api repo. An overlay file — if it exists — would override whatever terse description exists in the raw IDL. The overlay would be written in markdown and would contain paragraphs of description, links and example usages. It would be easy to add an overlay to the repo without breaking the build (i.e. there’s no need to keep all the docs inside the code as well-quoted strings where you have to satisfy the compiler). Thoughts/ suggestions/ improvements welcome! Cheers, Dave [1] There’s more than one copy on the web, but here’s the one I was looking at: http://xapi-project.github.io/xen-api/index.html
6.5 COMMANDS
Description: 6.5 COMMANDS
_______________________________________________ Xen-api mailing list Xen-api@lists.xen.org http://lists.xen.org/cgi-bin/mailman/listinfo/xen-api
