<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
</head>
<body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; color: rgb(0, 0, 0); font-size: 14px; font-family: Calibri, sans-serif; ">
<div>
<div>
<div>Love it! YES</div>
<div>
<div>
<div style="color: rgb(0, 0, 0); "><font class="Apple-style-span" color="rgb(0, 0, 0)" face="Apple Chancery"><i>Diane</i></font></div>
<div style="font-family: Calibri, sans-serif; font-size: 14px; color: rgb(0, 0, 0); ">
<font class="Apple-style-span" color="rgb(0, 0, 0)"><i>----------------------------------------------</i></font></div>
<div style="font-family: Calibri, sans-serif; font-size: 14px; color: rgb(0, 0, 0); ">
<font class="Apple-style-span" color="rgb(0, 0, 0)">Diane Fleming</font></div>
<div style="font-family: Calibri, sans-serif; font-size: 14px; ">
<div style="color: rgb(0, 0, 0); ">Software Developer II - US</div>
</div>
diane.fleming@rackspace.com</div>
<div>Cell 512.323.6799</div>
<div>Office 512.874.1260<br>
<span class="Apple-style-span" style="font-family: Calibri, sans-serif; ">
<div style="font-family: Calibri, sans-serif; font-size: 14px; ">
<div style="color: rgb(0, 0, 0); ">Skype drfleming0227</div>
<div style="color: rgb(0, 0, 0); ">Google-plus diane.fleming@gmail.com</div>
</div>
</span></div>
</div>
</div>
</div>
<div><br>
</div>
<span id="OLK_SRC_BODY_SECTION">
<div style="font-family:Calibri; font-size:11pt; text-align:left; color:black; BORDER-BOTTOM: medium none; BORDER-LEFT: medium none; PADDING-BOTTOM: 0in; PADDING-LEFT: 0in; PADDING-RIGHT: 0in; BORDER-TOP: #b5c4df 1pt solid; BORDER-RIGHT: medium none; PADDING-TOP: 3pt">
<span style="font-weight:bold">From: </span>Anne Gentle <<a href="mailto:anne@openstack.org">anne@openstack.org</a>><br>
<span style="font-weight:bold">Date: </span>Monday, March 10, 2014 11:09 AM<br>
<span style="font-weight:bold">To: </span>Gauvain Pocentek <<a href="mailto:gauvain.pocentek@objectif-libre.com">gauvain.pocentek@objectif-libre.com</a>><br>
<span style="font-weight:bold">Cc: </span>openstack-docs <<a href="mailto:openstack-docs@lists.openstack.org">openstack-docs@lists.openstack.org</a>><br>
<span style="font-weight:bold">Subject: </span>Re: [Openstack-docs] Prompts conventions<br>
</div>
<div><br>
</div>
<div>
<div>
<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.
<div><br>
</div>
<div>Anne</div>
</div>
<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>
</span>
</body>
</html>