<div dir="ltr">Hi Thomas,<div><br></div><div>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.</div><div><br></div><div>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?</div><div><br></div><div>Regards,</div><div>Konrad</div></div><div class="gmail_extra"><br clear="all"><div><div class="gmail_signature" data-smartmail="gmail_signature"><div dir="ltr"><div><div dir="ltr"><div dir="ltr"><div>Konrad Kleine</div><div><br></div><div>Software Engineer</div><div>Red Hat GmbH</div><div><span style="font-size:13px;line-height:16.12px">Werner-von-Siemens-Ring 15</span></div><div><span style="font-size:13px;line-height:16.12px">85630 Grasbrunn, </span><span style="font-size:13px;line-height:16.12px">Germany</span></div></div></div></div></div></div></div>
<br><div class="gmail_quote">On Mon, Aug 15, 2016 at 2:35 PM, Thomas Mäder <span dir="ltr"><<a href="mailto:tmader@redhat.com" target="_blank">tmader@redhat.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Hi folks,<br>
<br>
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?<br>
<br>
The same question applies to the REST API<br>
<br>
/Thomas<br>
<br>
______________________________<wbr>_________________<br>
almighty-public mailing list<br>
<a href="mailto:almighty-public@redhat.com" target="_blank">almighty-public@redhat.com</a><br>
<a href="https://www.redhat.com/mailman/listinfo/almighty-public" rel="noreferrer" target="_blank">https://www.redhat.com/mailman<wbr>/listinfo/almighty-public</a><br>
</blockquote></div><br></div>