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

[Hariharasubramanian Ramasubramanian]

Hi Jeremy,

Thanks for the comments. I agree with all and will soon update the doc to
address the comments.

I don't quite get what I need to be doing for your last comment:
      Also, a signed-off-by line is required, to indicate that you've
agreed
  to the Developers Certificate of Origin.

Thanks,
rhari !

Hariharasubramanian R.
Power Firmware Development
IBM India Systems & Technology Lab, Bangalore, India
Phone:  +91 80 4025 6950



From:	Jeremy Kerr <jk at ozlabs.org>
To:	openbmc at lists.ozlabs.org
Date:	03/15/2016 08:44 AM
Subject:	Re: [PATCH docs] REST API documentation for OpenBMC user
            management.
Sent by:	"openbmc" <openbmc-bounces
            +hramasub=in.ibm.com at lists.ozlabs.org>



Hi Hari,

> From: Hariharasubramanian R <hramasub at 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
_______________________________________________
openbmc mailing list
openbmc at lists.ozlabs.org
https://lists.ozlabs.org/listinfo/openbmc

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ozlabs.org/pipermail/openbmc/attachments/20160315/ccad10aa/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: graycol.gif
Type: image/gif
Size: 105 bytes
Desc: not available
URL: <http://lists.ozlabs.org/pipermail/openbmc/attachments/20160315/ccad10aa/attachment.gif>