<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Tue, Nov 11, 2014 at 1:49 AM, Andreas Jaeger <span dir="ltr"><<a href="mailto:aj@suse.com" target="_blank">aj@suse.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><span class="">On 11/09/2014 02:15 PM, Andreas Jaeger wrote:<br>
> As discussed in Paris, I've created a first spec to move drivers out of<br>
> openstack-manuals:<br>
> <a href="https://review.openstack.org/133372" target="_blank">https://review.openstack.org/133372</a><br>
><br>
> This still misses quite some parts and one of these is the following:<br>
> We currently document *all* options for a driver, so let's look at Block<br>
> Storage drivers:<br>
><br>
> We have for example the table "Table 1.3. Description of Dell EqualLogic<br>
> volume driver configuration options" at<br>
> <a href="http://docs.openstack.org/trunk/config-reference/content/dell-equallogic-driver.html" target="_blank">http://docs.openstack.org/trunk/config-reference/content/dell-equallogic-driver.html</a><br>
><br>
> Should we keep these tables and structure the documentation as follows:<br>
><br>
> Title: List of drivers<br>
> * Driver 1<br>
> * Driver 2<br>
><br>
> Title: Configuration Options for all drivers<br>
> One page with all configuration options<br>
><br>
> I see the following alternatives:<br>
> * Do not document these configuration options at all<br>
> * Use a different structure (proposals welcome)<br>
><br>
> Please reply with your suggestions.<br>
><br>
> Andreas<br>
><br>
<br>
</span>Tom commented in the review with:<br>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~<br>
See<br>
<a href="http://docs.openstack.org/trunk/config-reference/content/sheepdog-driver.html" target="_blank">http://docs.openstack.org/trunk/config-reference/content/sheepdog-driver.html</a><br>
<-- I think something like this which has the one quick reference line<br>
that you need, along with the link could be useful.<br>
Another example (I know it's open source, but for example's sake) is<br>
<a href="http://docs.openstack.org/trunk/config-reference/content/smbfs-volume-driver.html" target="_blank">http://docs.openstack.org/trunk/config-reference/content/smbfs-volume-driver.html</a><br>
<-- Imagine there's also a link in there to the vendor docs, and with<br>
quick reference line (which almost never changes), table of options<br>
automatically generated from code means no maintenance cost.<br>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~<br>
<br>
I like the combination of Samba and sheepdog to create "version<br>
independent" information:<br>
<br>
* A short paragraph explaining the driver.<br>
* A link for detailed instructions<br>
* A default paragraph like:<br>
  Set the following in your cinder.conf, and use the following options<br>
to configure it.<br>
volume_driver=cinder.volume.drivers.smbfs.SmbfsDriver<br>
* And finally the autogenerated configuration options<br>
<div class="HOEnZb"><div class="h5"><br></div></div></blockquote><div><br></div><div>I like this as well as a template that vendors (or projects) can then write to. Sounds good.</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="HOEnZb"><div class="h5">
Andreas<br>
--<br>
 Andreas Jaeger aj@{<a href="http://suse.com" target="_blank">suse.com</a>,<a href="http://opensuse.org" target="_blank">opensuse.org</a>} Twitter/Identica: jaegerandi<br>
  SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany<br>
   GF:Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB 21284 (AG Nürnberg)<br>
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126<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" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
</div></div></blockquote></div><br></div></div>