[OpenStack-docs] OpenStack docs migration questions

Gauvain Pocentek gauvain.pocentek at objectif-libre.com
Wed Mar 11 06:16:46 UTC 2015


Le 2015-03-10 13:55, Anne Gentle a écrit :
> On Tue, Mar 10, 2015 at 6:49 AM, darren chan <dazzachan at yahoo.com.au> 
> wrote:
> 
>> I have a few questions regarding the docs migration process.
>> How do we approach converting docs (for example, the HOT guide) which 
>> are automatically generated?
> 
> I didn't have the task of "stop outputting docbook from rst" in the
> detailed scope for this release, since the HOT Guide chapter is
> already RST. But, I guess if there is scraping, openstack-doc-tools
> will have to change to "stop outputting docbook and start outputting
> rst" -- what do we want to do there?

There's a manual step to handle the inclusion of the hot-guide content 
in the user-guide (running a script that calls os-doc-tools to convert 
from rst to docbook). So the only things we need to do for the hot-guide 
is to copy/move its .rst files in the RST user-guide, add a line in 
index.rst, and we should be done.

I actually have a patch somewhere that I could submit for review.

Gauvain


> 
>  
> 
>> Where do we put RST files migrated from the doc/common folder? There 
>> are a number of common files used in the CLI chapter of the End User 
>> Guide.
> 
> I think they should go into doc/playground-user-guide/source/common
> for now. Once we get more guides in RST we'll go to something closer
> to our current structure.
> 
> Thanks for all the conversions you're doing Darren! I'll keep
> plugging through the admin guide.
> Anne
> 
>  
> 
> Thanks,
> D
> 
>> OpenStack-docs mailing list
>> OpenStack-docs at lists.openstack.org
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs 
>> [1]
>> 
>> --
>> 
>> Anne Gentle
>> annegentle at justwriteclick.com
> 
> 
> Links:
> ------
> [1] http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> 
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Gauvain Pocentek

Objectif Libre - Infrastructure et Formations Linux
http://www.objectif-libre.com



More information about the OpenStack-docs mailing list