[Openstack-docs] api-ref-guide publishing

Diane Fleming diane.fleming at RACKSPACE.COM
Thu Mar 27 18:38:30 UTC 2014


Andreas, 

The plan is to take the generated PDFs and provide links for them on the
relevant pages - I still have to add the code to add the PDF links.

So on the http://api.openstack.org/api-ref-compute-v2.html page (for
example), there will be a link to the api-ref-compute-v2.pdf.

Does that make sense?

There won't be any links on the main docs landing page to these PDFs.

I can change the pom so that all the PDFs appear in the same directory
(though I'm not sure how that matters for what I'm doing).

Diane
----------------------------------------------
Diane Fleming
Software Developer II - US

diane.fleming at rackspace.com
Cell  512.323.6799
Office 512.874.1260
Skype drfleming0227
Google-plus diane.fleming at gmail.com






On 3/27/14 1:22 PM, "Andreas Jaeger" <aj at suse.com> wrote:

>Hi Diane,
>
>I see that your patch https://review.openstack.org/#/c/82591/ generates
>a lot of directories:
>
>$ l api-ref-guides/target/docbkx/webhelp/
>total 48
>drwxr-xr-x 12 aj users 4096 Mar 27 19:00 ./
>drwxr-xr-x  7 aj users 4096 Mar 27 19:00 ../
>drwxr-xr-x  5 aj users 4096 Mar 27 18:55 api-ref-blockstorage/
>drwxr-xr-x  5 aj users 4096 Mar 27 18:55 api-ref-compute-v2/
>drwxr-xr-x  5 aj users 4096 Mar 27 18:56 api-ref-compute-v2-ext/
>drwxr-xr-x  5 aj users 4096 Mar 27 18:57 api-ref-compute-v3/
>drwxr-xr-x  5 aj users 4096 Mar 27 18:59 api-ref-identity/
>drwxr-xr-x  5 aj users 4096 Mar 27 18:59 api-ref-image/
>drwxr-xr-x  5 aj users 4096 Mar 27 18:59 api-ref-networking/
>drwxr-xr-x  5 aj users 4096 Mar 27 19:00 api-ref-objectstorage/
>drwxr-xr-x  5 aj users 4096 Mar 27 19:00 api-ref-orchestration/
>drwxr-xr-x  5 aj users 4096 Mar 27 19:00 api-ref-telemetry/
>
>This is currently not supported by the tools, but I can fix it. But let
>me ask first under which URL should these get published?
>
>For example, what will be the URLs for api-ref-blockstorage,
>api-ref-compute-v2 and api-ref-copmute-v2-ext?
>
>Also, where's the common directory with overall content? If I just open
>file:///home/aj/Software/vcs/OpenStack/api-site/api-ref-guides/target/docb
>kx/webhelp/api-ref-blockstorage/content/blockstorage-v2.html,
>I do not get the other guides at all.
>
>How is this supposed to work?
>
>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




More information about the Openstack-docs mailing list