<div dir="ltr">I think we should copy what input/output looks like using the CLI... similar to [1].</div><div class="gmail_extra"><br><div class="gmail_quote">On Wed, Dec 23, 2015 at 8:48 PM, KATO Tomoyuki <span dir="ltr"><<a href="mailto:tomo@dream.daynight.jp" target="_blank">tomo@dream.daynight.jp</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Hi team,<br>
<br>
I have a question about command exaple conventions.<br>
Do we have or need the conventions?<br>
<br>
We have inconsistency about the command exaple as of now.<br>
<br>
1. command as-is [1]<br>
2. a blank line between input and output [2]<br>
3. separate block, input and output [3]<br>
<br>
My concern is that we get numerous patches, for example [4].<br>
<br>
- "It's easy to read by adding a blank line"<br>
- "The docs has an unnecessary blank line that command doesn't output.<br>
So, I remove it."<br>
- Add<br>
- Remove ... ... ...<br>
<br>
I recommend the option 1 as conventions,<br>
but just a recommendation, not mandatory.<br>
<br>
[1] <a href="http://docs.openstack.org/liberty/install-guide-ubuntu/keystone-verify.html" rel="noreferrer" target="_blank">http://docs.openstack.org/liberty/install-guide-ubuntu/keystone-verify.html</a><br>
[2] <a href="http://docs.openstack.org/image-guide/image-metadata.html" rel="noreferrer" target="_blank">http://docs.openstack.org/image-guide/image-metadata.html</a><br>
[3] <a href="http://docs.openstack.org/user-guide/cli_config_drive.html" rel="noreferrer" target="_blank">http://docs.openstack.org/user-guide/cli_config_drive.html</a><br>
[4] <a href="https://review.openstack.org/#/c/260669/" rel="noreferrer" target="_blank">https://review.openstack.org/#/c/260669/</a><br>
<br>
Regards,<br>
KATO Tomoyuki<br>
<br>
_______________________________________________<br>
OpenStack-docs mailing list<br>
<a href="mailto:OpenStack-docs@lists.openstack.org">OpenStack-docs@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
</blockquote></div><br></div>