Open Stack

I think we should copy what input/output looks like using the CLI...
similar to [1].

On Wed, Dec 23, 2015 at 8:48 PM, KATO Tomoyuki <tomo at dream.daynight.jp>
wrote:

> Hi team,
>
> I have a question about command exaple conventions.
> Do we have or need the conventions?
>
> We have inconsistency about the command exaple as of now.
>
>   1. command as-is [1]
>   2. a blank line between input and output [2]
>   3. separate block, input and output [3]
>
> My concern is that we get numerous patches, for example [4].
>
> - "It's easy to read by adding a blank line"
> - "The docs has an unnecessary blank line that command doesn't output.
>    So, I remove it."
> - Add
> - Remove ... ... ...
>
> I recommend the option 1 as conventions,
> but just a recommendation, not mandatory.
>
> [1]
> http://docs.openstack.org/liberty/install-guide-ubuntu/keystone-verify.html
> [2] http://docs.openstack.org/image-guide/image-metadata.html
> [3] http://docs.openstack.org/user-guide/cli_config_drive.html
> [4] https://review.openstack.org/#/c/260669/
>
> Regards,
> KATO Tomoyuki
>
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20151223/9c048ded/attachment.html>