[almighty] CLI Documentation

Pete Muir pmuir at redhat.com
Mon Aug 15 12:58:02 UTC 2016


For REST, Swagger seems to be almost universal nowadays.

On 15 August 2016 at 08:35, 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




More information about the almighty-public mailing list