[OpenStack-docs] Spec: Moving drivers out of openstack-manuals - documenting options

Andreas Jaeger aj at suse.com
Sun Nov 9 13:15:23 UTC 2014


As discussed in Paris, I've created a first spec to move drivers out of
openstack-manuals:
https://review.openstack.org/133372

This still misses quite some parts and one of these is the following:
We currently document *all* options for a driver, so let's look at Block
Storage drivers:

We have for example the table "Table 1.3. Description of Dell EqualLogic
volume driver configuration options" at
http://docs.openstack.org/trunk/config-reference/content/dell-equallogic-driver.html

Should we keep these tables and structure the documentation as follows:

Title: List of drivers
* Driver 1
* Driver 2

Title: Configuration Options for all drivers
One page with all configuration options

I see the following alternatives:
* Do not document these configuration options at all
* Use a different structure (proposals welcome)

Please reply with your suggestions.

Andreas
-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
  SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF:Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB 21284 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126



More information about the OpenStack-docs mailing list