Re: [PATCH docs] REST API documentation for OpenBMC user management.

[Jeremy Kerr <jk@ozlabs.org>]

Hi Hari,

> From: Hariharasubramanian R <hramasub@in.ibm.com>
> 
> ---
>  obmc-userman.md | 82 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++

Thanks for this! It's great to have this document. A couple of comments.
They're pretty minor though:

The doc makes reference to the REST API, but is this also applicable to
DBUS? If so, we might want to split this up a little:

 - formal DBUS specs should do into the dbus-interfaces.md document

 - informal usage guides can be a separate document

It seems that this is more the latter, which is fine. However, you may
also want to consider adding a spec to the dbus-interfaces doc as an
additional change.

The term 'userman' could be interpreted to mean "User Manual", not "User
Management". We don't really need to contract filenames this much,
calling it something like user-management.md would be fine.

Could you wrap lines at 80 chars? This makes things easier to read in
text form. Also, can you also add a reference to this to the main
README.md doc?

Also, a signed-off-by line is required, to indicate that you've agreed
to the Developers Certificate of Origin.

Cheers,


Jeremy