<div dir="ltr">+1 ... great idea!</div><div class="gmail_extra"><br><br><div class="gmail_quote">On Mon, Mar 10, 2014 at 10:09 AM, Anne Gentle <span dir="ltr"><<a href="mailto:anne@openstack.org" target="_blank">anne@openstack.org</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr">Yes! Please do so. Those conventions sound correct and I meant to add them to the Operations Guide and the Documentation/Conventions wiki page so I greatly appreciate the offer.<span class="HOEnZb"><font color="#888888"><div>
<br></div><div>Anne</div>

</font></span></div><div class="HOEnZb"><div class="h5"><div class="gmail_extra"><br><br><div class="gmail_quote">On Mon, Mar 10, 2014 at 11:07 AM, Gauvain Pocentek <span dir="ltr"><<a href="mailto:gauvain.pocentek@objectif-libre.com" target="_blank">gauvain.pocentek@objectif-libre.com</a>></span> wrote:<br>


<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Hello,<br>
<br>
We have a lot of shell prompts in the documentation, and there doesn't seem to be a convention defining in which case $ or # should be used. We also have an inconsistent use of sudo.<br>
<br>
I'd like to suggest the following convention:<br>
<br>
* use # for commands that *need* root privileges to work (*-manage, mysqladmin, service...)<br>
* use $ for commands that don't require root privileges (all the clients)<br>
* never use sudo<br>
* add a "Conventions used in this book" section in all guides (as is done in all the tech books I ever read) to explain what the prompts actually mean:<br>
  - # => you must be root or use sudo<br>
  - $ => you can run the command as unprivileged user, but as root as well<br>
<br>
I guess you can call this nitpicking but I've seen a couple of users confused in bug reports, and consistency is Good anyway :)<br>
<br>
Let me know what you think and if we agree on this (or an updated proposal) I'll update the wiki and start working on this (might be a simple way to get started for newcomers as well).<br>
<br>
Thanks,<br>
Gauvain<br>
<br>
Objectif Libre - Infrastructure et Formations Linux<br>
<a href="http://www.objectif-libre.com" target="_blank">http://www.objectif-libre.com</a><br>
<br>
______________________________<u></u>_________________<br>
Openstack-docs mailing list<br>
<a href="mailto:Openstack-docs@lists.openstack.org" target="_blank">Openstack-docs@lists.<u></u>openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" target="_blank">http://lists.openstack.org/<u></u>cgi-bin/mailman/listinfo/<u></u>openstack-docs</a><br>
</blockquote></div><br></div>
</div></div><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" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
<br></blockquote></div><br></div>