Open Stack

Le 2016-08-31 13:19, Deshpande, Vinita a écrit :
> Thanks Gauvain, I am able to now generate the cinder-coprhd.rst file
> in my local setup. Do, I need to submit this generated file somewhere?
>  Also, do I need to remove the line ' .. include::
> ../../tables/cinder-coprhd.rst' from my documentation
> file(coprhd-driver.rst) ? If this line is present, I am
> Getting the error - 'No such file : cinder-coprhd.rst'.

You just need to add your file to your review: 
https://review.openstack.org/#/c/352822/ , it should be enough.

Gauvain

> 
> 
> -----Original Message-----
> From: Gauvain Pocentek [mailto:gauvain.pocentek at objectif-libre.com]
> Sent: Wednesday, August 31, 2016 2:28 PM
> To: Deshpande, Vinita
> Cc: openstack-docs at lists.openstack.org; Hallur, Parashuram; yang,
> xing; Kulkarni, Mallari
> Subject: Re: [OpenStack-docs] Process to add a table in 
> openstack-manuals
> 
> Hello Vinita,
> 
> Le 2016-08-31 10:12, Deshpande, Vinita a écrit :
>> Hello everybody,
>> 
>> I have raised a pull request in openstack for our CoprHD volume 
>> driver
>> documentation in openstack-manuals project. Pull request :
>> https://review.openstack.org/#/c/352822/ [1]
>> 
>> My driver doc uses a table (cinder-coprhd.rst), which is supposed to
>> be auto-generated as per a comment given on the pull request. As I am
>> completely new to this, can someone please guide me on how to add the
>> table in "doc/config-reference/source/tables" ?
>> 
>> I have already added ".. include:: ../../tables/cinder-coprhd.rst" in
>> my documentation.
> 
> The tools that can generate this file is in the openstack-doc-tools 
> git
> repo:
> https://github.com/openstack/openstack-doc-tools/tree/master/autogenerate_config_docs
> 
> The README describes how you can setup your environment, then you
> would have to run:
> 
> $ ./autohelp-wrapper update cinder
> $ vim
> sources/openstack-manuals/tools/autogenerate-config-flagmappings/cinder.*
> $ ./autohelp-wrapper rst cinder
> 
> In the cinder.flagmappings file you have to add a 'coprhd' next to
> the options you driver brings, and you can add a 'coprhd' entry in the
> cinder.headers file to get a nice title for the table.
> 
> HTH,
> Gauvain

Gauvain Pocentek

Objectif Libre - Infrastructure et Formations Linux
http://www.objectif-libre.com
phone: +33 972 54 98 01 / +33 611 60 84 25