<div dir="ltr">Anyone else want to comment? This issue affects most of the installation guide improvement patches.</div><div class="gmail_extra"><br><br><div class="gmail_quote">On Wed, Jun 11, 2014 at 1:33 PM, Diane Fleming <span dir="ltr"><<a href="mailto:diane.fleming@rackspace.com" target="_blank">diane.fleming@rackspace.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div style="word-wrap:break-word;color:rgb(0,0,0);font-size:14px;font-family:Calibri,sans-serif">
<div>
<div>
<div>Thanks Matt.</div>
<div><br>
</div>
<div>I'm in favor of breaking procedures that are longer than 10 steps into smaller procedures. Otherwise, when possible, use a single procedure.</div>
<div><br>
</div>
<div>I don't think consistency gains us much, if anything, in this case. </div>
<div><br>
</div>
<div>Here's some good general guidance about procedures:</div>
<div><br>
</div>
<div><a href="http://www.helpscribe.com/2008/01/11-tips-for-writing-incredibly-useful.html" target="_blank">http://www.helpscribe.com/2008/01/11-tips-for-writing-incredibly-useful.html</a></div>
<div><br>
</div>
<div>
<div>
<div style="color:rgb(0,0,0)"><font 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 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 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>
<a href="mailto:diane.fleming@rackspace.com" target="_blank">diane.fleming@rackspace.com</a></div>
<div>Cell <a href="tel:512.323.6799" value="+15123236799" target="_blank">512.323.6799</a></div>
<div>Office <a href="tel:512.874.1260" value="+15128741260" target="_blank">512.874.1260</a><br>
<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 <a href="mailto:diane.fleming@gmail.com" target="_blank">diane.fleming@gmail.com</a></div>
</div>
</div>
</div>
</div>
</div>
<div><br>
</div>
<span>
<div style="font-family:Lucida Grande;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>Matt Kassawara <<a href="mailto:mkassawara@gmail.com" target="_blank">mkassawara@gmail.com</a>><br>
<span style="font-weight:bold">Date: </span>Wednesday, June 11, 2014 2:03 PM<br>
<span style="font-weight:bold">To: </span>"<a href="mailto:openstack-docs@lists.openstack.org" target="_blank">openstack-docs@lists.openstack.org</a>" <<a href="mailto:openstack-docs@lists.openstack.org" target="_blank">openstack-docs@lists.openstack.org</a>><br>
<span style="font-weight:bold">Subject: </span>[Openstack-docs] Installation and configuration section structure<br>
</div><div><div class="h5">
<div><br>
</div>
<div>
<div>
<div dir="ltr">
<div>Prior to the Icehouse installation guide networking updates project, the structure for most installation and configuration sections consisted of one procedure containing steps/substeps. While working on the networking updates project, I found this structure
difficult for us to code and for our audience to follow with more complex services such as neutron. After trying some variants of the original structure, I eventually decided to break each group of related steps into separate procedures. To provide our audience
with consistency, I think we should implement this structure throughout the installation guide during the improvement project. However, this structure leans toward overkill for simpler services such as keystone. We need to determine whether we stick with consistency
or adjust structure based on service complexity. Please take a look at the following examples of each structure and provide your opinions.</div>
<div><br>
</div>
<div>Separate procedures:</div>
<div><br>
</div>
<div><a href="http://docs.openstack.org/icehouse/install-guide/install/apt/content/neutron-ml2-network-node.html" target="_blank">http://docs.openstack.org/icehouse/install-guide/install/apt/content/neutron-ml2-network-node.html</a><br>
</div>
<div><br>
</div>
<div><a href="http://docs-draft.openstack.org/59/96059/4/check/gate-openstack-manuals-tox-doc-publish-checkbuild/32a4a38/publish-docs/trunk/install-guide/install/apt/content/keystone-install.html" target="_blank">http://docs-draft.openstack.org/59/96059/4/check/gate-openstack-manuals-tox-doc-publish-checkbuild/32a4a38/publish-docs/trunk/install-guide/install/apt/content/keystone-install.html</a><br>
</div>
<div><br>
</div>
<div>One procedure:</div>
<div><br>
</div>
<div><a href="http://docs-draft.openstack.org/59/96059/10/check/gate-openstack-manuals-tox-doc-publish-checkbuild/d804200/publish-docs/trunk/install-guide/install/apt/content/keystone-install.html" target="_blank">http://docs-draft.openstack.org/59/96059/10/check/gate-openstack-manuals-tox-doc-publish-checkbuild/d804200/publish-docs/trunk/install-guide/install/apt/content/keystone-install.html</a><br>
</div>
<div><br>
</div>
<div>Matt</div>
</div>
</div>
</div>
</div></div></span>
</div>
</blockquote></div><br></div>