Re: [Xen-API] improving the XenAPI docs

2015-02-12 Thread Rob Hoes
I quite like these ideas for improving the XenAPI docs. I think adding tags to the fields and functions so they can be logically grouped is a good idea. We have recently started collecting some docs about the use of the XenAPI on xapi-project.github.io, and have pages for several topics, e.g. h

Re: [Xen-API] improving the XenAPI docs

2015-01-28 Thread Stephen Turner
Thanks for raising this, Dave. I think documenting the fields helpfully is important, but examples are key too because that's how people build code in practice. One more thing I would add: there are too many hash tables (other_config, sm_config, etc.) where the possible (or perhaps I should say

Re: [Xen-API] improving the XenAPI docs

2015-01-27 Thread Jesse Benedict
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 sharin

[Xen-API] improving the XenAPI docs

2015-01-27 Thread Dave Scott
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 ord