<html><body><div style="color:#000; background-color:#fff; font-family:HelveticaNeue, Helvetica Neue, Helvetica, Arial, Lucida Grande, sans-serif;font-size:16px"><div dir="ltr">One can always say "for example" or something to avoid implying that OpenStack can only be</div><div dir="ltr">deployed on the distros that are listed.</div><div dir="ltr"><br></div><div id="yui_3_16_0_1_1437116378066_1894136" dir="ltr">+1 for more symlinks. And, of course, our job is not to teach people how to use the operating system,</div><div dir="ltr">but the subtle differences between distros can mess people up. For example, an experienced Debian/Ubuntu</div><div dir="ltr">person who is deploying on RHEL/Centos may need a hint when RHEL/Centos does something differently.</div><div dir="ltr"><br></div><div dir="ltr">Another thought is to put details about, say, differences in "restart" between distros and then link to that whenever</div><div dir="ltr">we include a restart step in a procedure. I'm not sure of the details here.</div><div dir="ltr"><br></div><div id="yui_3_16_0_1_1437116378066_1894138" dir="ltr">I admit that, when I am following a procedure, I tend to glance at the prose then copy-and-paste the command from</div><div dir="ltr">the docs into my shell. As someone else mentioned, this is probably even more true for people who are less comfortable</div><div dir="ltr">with the English language.<br></div><div dir="ltr"><br></div> <blockquote id="yui_3_16_0_1_1437116378066_1894144" style="border-left: 2px solid rgb(16, 16, 255); margin-left: 5px; margin-top: 5px; padding-left: 5px;"> <div id="yui_3_16_0_1_1437116378066_1894143" style="font-family: HelveticaNeue, Helvetica Neue, Helvetica, Arial, Lucida Grande, sans-serif; font-size: 16px;"> <div id="yui_3_16_0_1_1437116378066_1894142" style="font-family: HelveticaNeue, Helvetica Neue, Helvetica, Arial, Lucida Grande, sans-serif; font-size: 16px;"> <div id="yui_3_16_0_1_1437116378066_1894141" dir="ltr"> <hr size="1"> <font id="yui_3_16_0_1_1437116378066_1894140" face="Arial" size="2"> <b><span style="font-weight:bold;">From:</span></b> Matt Kassawara <mkassawara@gmail.com><br> <b><span style="font-weight: bold;">To:</span></b> Gauvain Pocentek <gauvain.pocentek@objectif-libre.com> <br><b><span style="font-weight: bold;">Cc:</span></b> "openstack-docs@lists.openstack.org" <openstack-docs@lists.openstack.org> <br> <b><span style="font-weight: bold;">Sent:</span></b> Tuesday, July 21, 2015 6:41 AM<br> <b><span style="font-weight: bold;">Subject:</span></b> Re: [OpenStack-docs] distro-specific commands in guides<br> </font> </div> <div id="yui_3_16_0_1_1437116378066_1894147" class="y_msg_container"><br><div id="yiv4303159531"><div id="yui_3_16_0_1_1437116378066_1894150"><div id="yui_3_16_0_1_1437116378066_1894149" dir="ltr">Outside of the installation guide, we should avoid using any commands specific to distributions or packages because our audience may incorrectly assume the documentation limits how and where they can deploy OpenStack. Similarly, we should avoid spelling out general OS commands (such as making symlinks and showing network interfaces) because our audience should already understand how to use the OS before deploying OpenStack.</div><div class="yiv4303159531gmail_extra"><br clear="none"><div class="qtdSeparateBR"><br><br></div><div class="yiv4303159531yqt8007266271" id="yiv4303159531yqtfd82531"><div class="yiv4303159531gmail_quote">On Mon, Jul 20, 2015 at 10:24 PM, Gauvain Pocentek <span dir="ltr"><<a rel="nofollow" shape="rect" ymailto="mailto:gauvain.pocentek@objectif-libre.com" target="_blank" href="mailto:gauvain.pocentek@objectif-libre.com">gauvain.pocentek@objectif-libre.com</a>></span> wrote:<br clear="none"><blockquote class="yiv4303159531gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;"><span class="yiv4303159531">Le 2015-07-20 14:44, Christian Berendt a écrit :<br clear="none">
</span><blockquote class="yiv4303159531gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">
On 07/19/2015 06:26 PM, Tom Fifield wrote:<br clear="none">
<blockquote class="yiv4303159531gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">
On the other hand, I agree that it is a fair assumption that our readers<br clear="none">
understand how to do a service restart - this is a fairly basic and<br clear="none">
essential sysadmin practice.<br clear="none">
</blockquote>
<br clear="none">
+1<br clear="none">
<br clear="none">
Maybe we should add a list of required and assumed previous knowledge.<br clear="none">
</blockquote>
<br clear="none">
I can start this list but for now service restart is the only obvious element I can think of. Maybe we could just leave it at that and simply add a "don't write CLI samples for service restarts, except in the install guide" to the conventions.<br clear="none">
<br clear="none">
How does it sound?<br clear="none">
<br clear="none">
Thanks,<br clear="none">
Gauvain<div class="yiv4303159531HOEnZb"><div class="yiv4303159531h5"><br clear="none">
<br clear="none">
_______________________________________________<br clear="none">
OpenStack-docs mailing list<br clear="none">
<a rel="nofollow" shape="rect" ymailto="mailto:OpenStack-docs@lists.openstack.org" target="_blank" href="mailto:OpenStack-docs@lists.openstack.org">OpenStack-docs@lists.openstack.org</a><br clear="none">
<a rel="nofollow" shape="rect" target="_blank" href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br clear="none">
</div></div></blockquote></div><br clear="none"></div></div></div></div><br><div class="yqt8007266271" id="yqtfd67218">_______________________________________________<br clear="none">OpenStack-docs mailing list<br clear="none"><a shape="rect" ymailto="mailto:OpenStack-docs@lists.openstack.org" href="mailto:OpenStack-docs@lists.openstack.org">OpenStack-docs@lists.openstack.org</a><br clear="none"><a shape="rect" 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 clear="none"></div><br><br></div> </div> </div> </blockquote> </div></body></html>