[almighty] CLI Documentation

[Konrad Kleine]

Hi Thomas,

I think that most of the CLI programs are self-explanatory in one was or
another, yet most of them still have man pages or some form of online
documentation.

IMHO, no matter what format the documentation would be like, it should be
possible to learn more about the program without having it installed or
available to play with somewhere. Makes sense?

Regards,
Konrad

Konrad Kleine

Software Engineer
Red Hat GmbH
Werner-von-Siemens-Ring 15
85630 Grasbrunn, Germany

On Mon, Aug 15, 2016 at 2:35 PM, Thomas Mäder <tmader at redhat.com> wrote:

> Hi folks,
>
> It has been requested that we document our command line interface. To me,
> however it's not quite clear in what form we should do that: technically,
> the cli is self-documenting. If you do "alm-cli --help", it will give you a
> list of possible commands and options. The alm-cli command is mentioned in
> the developer set up section on github. Do we believe this is sufficient?
> What else is necessary?
>
> The same question applies to the REST API
>
> /Thomas
>
> _______________________________________________
> almighty-public mailing list
> almighty-public at redhat.com
> https://www.redhat.com/mailman/listinfo/almighty-public
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/almighty-public/attachments/20160815/edf7e989/attachment.htm>