Open Stack

On 02/26/2014 07:49 AM, Sam Harwell wrote:
> <!-- % Title -->

Is that an existing pandoc directive? I see that it's passed on into the
DocBook, so I could use an xslt to grab the title from a comment like
that. Or we could use the convention that the markdown doc should have a
single top level heading. I.e. if the first heading is:

#OpenStack Image Service API v2 Reference

Then all the other headings in that file should be ## or lower. Then we
could use the first heading as the title of the chapter.

Regards,
David

> 
> -----Original Message-----
> From: Andreas Jaeger [mailto:aj at suse.com] 
> Sent: Tuesday, February 25, 2014 11:36 PM
> To: openstack-docs at lists.openstack.org
> Cc: dolph.mathews at gmail.com
> Subject: [Openstack-docs] Markdown conversion challenges
> 
> Converting from Markdown to Docbook for publishing has some challenges.
> 
> One example is that markdown creates an empty chapter by default and needs special notation to get this in.
> 
> David proposed the following patch to fix some of the issues:
> 
> https://review.openstack.org/#/c/75483/
> 
> Which now gave a "No title" as default chapter - which was fixed for identity-api with this patch:
> https://review.openstack.org/75490
> 
> But now markdown is broken as Mathew pointed out:
> 
> https://github.com/openstack/identity-api/blob/master/openstack-identity-api/v3/src/markdown/identity-api-v3.md
> 
> With this patch reverted, you see how it looks like:
> http://docs-draft.openstack.org/90/76390/1/check/gate-identity-api-tox-doc-publish-checkbuild/6aa6f4e/publish-docs/api/openstack-identity-service/3/content/index.html
> 
> Does anybody have a good solution to move forward here?
> 
> Andreas
> --
>  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
>   SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
>    GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
>     GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126
> 
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> 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
>