Re: OpenLMI Storage Scripts documentation
On 08/22/2013 01:53 PM, Stephen Gallagher wrote:
I was reading through the Storage Scripts documentation[1] today.
First of all, excellent work Jan. It's very clear and concise and
I don't think anyone will have any trouble with it (particularly
the LMI command line reference).
I do have two suggestions:
1) You've bundled in the LMI command line reference for the
services and software providers as well. I'm not sure if this was a
mistake, but it might be better to just provide a link to
documentation for other providers, rather than including them in
this document.
Other commands were included just to check my script if it generates
nice documentation also for the others, in the end there must be
separate chapter for each provider.
2) The Python/lmishell reference is very detailed, but I think it
would benefit with a few specific examples of the usage. Also, I
think we probably want to include a section on how to establish a
connection with the Python/lmishell interface and include a copy of
it in each of the reference documentations for the various lmi
scripts.
Yeah, I know, current documentation is just generated from sources. It
misses the 'big picture', where to start, how to use it, examples etc.
I just don't have enough time :(.
Jan