Open Stack

On Tue, Mar 10, 2015 at 8:28 AM, Erlon Cruz <sombrafam at gmail.com> wrote:

> Hi Anne,
>
> How about driver documentation that is in the old format? Will it be
> removed in Kilo?
>


Hi Erlon,
The spec doesn't have a specific person assigned for removal, and the only
drivers the docs team "signed up for" through the blueprint are these:


   - For cinder: volume drivers: document LVM and NFS; backup drivers:
   document swift
   - For glance: Document local storage, cinder, and swift as backends
   - For neutron: document ML2 plug-in with the mechanisms drivers
   OpenVSwitch and LinuxBridge
   - For nova: document KVM (mostly), send Xen open source call for help
   - For sahara: apache hadoop
   - For trove: document all supported Open Source database engines like
   MySQL.





> The wiki says: "Bring all driver sections that are currently just ‘bare
> bones’ up to the standard mentioned." Will this be performed by core team?
>

Andreas has done some of that work, for example here:
https://review.openstack.org/#/c/157086/

We can use more hands of course, just coordinate the work here on the list.
And Andreas, if there aren't any more to do, let us know. :)
Thanks,
Anne



>
> Thanks,
> Erlon
>
> On Fri, Mar 6, 2015 at 4:58 PM, Anne Gentle <annegentle at justwriteclick.com
> > wrote:
>
>> Hi all,
>>
>> We have been working on streamlining driver documentation for Kilo
>> through a specification, on the mailing lists, and in my weekly What's Up
>> Doc updates. Thanks for the reviews while we worked out the solutions.
>> Here's the final spec:
>>
>> http://specs.openstack.org/openstack/docs-specs/specs/kilo/move-driver-docs.html
>>
>> Driver documentation caretakers, please note the following summary:
>>
>> - At a minimum, driver docs are published in the Configuration Reference
>> at with tables automatically generated from the code. There's a nice set of
>> examples in this patch: https://review.openstack.org/#/c/157086/
>>
>> - If you want full driver docs on docs.openstack.org, please add a
>> contact person's name and email to this wiki page:
>> https://wiki.openstack.org/wiki/Documentation/VendorDrivers
>>
>> - To be included in the April 30 release of the Configuration Reference,
>> driver docs are due by April 9th.
>>
>> Thanks all for your collaboration and attention.
>>
>> Anne
>>
>>
>> --
>> Anne Gentle
>> annegentle at justwriteclick.com
>>
>> __________________________________________________________________________
>> OpenStack Development Mailing List (not for usage questions)
>> Unsubscribe:
>> OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>>
>>
>
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>
>


-- 
Anne Gentle
annegentle at justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20150310/5dc356c5/attachment.html>