[OpenStack-docs] Cross-references between documents

Meg McRoberts dreidellhasa at yahoo.com
Wed Jun 3 04:41:17 UTC 2015


This clarifies things a bit.
Alas, I think about 90% of the xrefs I need to make are to the Install Guides and the Config Ref.So what do you recommend?

 
      From: Lana Brindley <openstack at lanabrindley.com>
 To: Meg McRoberts <dreidellhasa at yahoo.com>; Andreas Jaeger <aj at suse.com> 
Cc: "openstack-docs at lists.openstack.org" <openstack-docs at lists.openstack.org> 
 Sent: Tuesday, June 2, 2015 9:25 PM
 Subject: Re: Cross-references between documents
   
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 03/06/15 11:17, Meg McRoberts wrote:
> So are you saying we can only link to whole books, not to individual sections of books?  I guess one can give the section titlein the text surrounding the link but it puts quite a burden on the reader to find the relevant material.

You can absolutely deep link to chapter or section level, that's fine.

> 
> So the "draft" site is for docs being developed for Liberty, right?  But if I use "liberty" in the URL, the links won't workas we're trying to develop the content.  Will kilo links be automagically updated to liberty when the time comes or willthat also be a manual procedure?.

We only have two books that are versioned, everything else is
continuously integrated. So, in most case, you can link to
docs.openstack.org/[bookname] and that will not change with each
version. It's only the Install Guide and the Config Ref that are
versioned and therefore may go out of date.

> The HA Guide content is so intimately related to the content of several other guides so this may be more important to methan to some other people.  And I realize that we may need to live with some ugliness until everything is converted to RSTand we implement intersphinx -- I just need to understand.

Of course. Please let me know if this makes it clearer, or if I've just
confused you further :)

L

- -- 
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVboGrAAoJELppzVb4+KUyvwgH/jiN06bqKgOy/rpp/DrD2TKM
j6KiSmoe7JEqwx2tqduJvi03fQzeHy2RUxuCjUIn9y2Ya/1e0Jd4vE2tjcJLuLCY
lsw7i+WeCZrXw/GtutWT7UntrrjeLA1we7csGIKVivhzrGiqgE9v7dhh8XbJXdj2
xeVc/jQ8ETmH9SpZHia8sGB1JtROlaYSN4nvt6aK1yXQOSsujBAphorye6/ZGnev
oLqE+VwJ06SKPfYCl0tN7bFmesc0f6mtMeV0avFj/rGq7JhslUe2vukrwyat/ITR
Lo38ZD2ec8kR0k9Bjp0R7p1DIlRvnUtOZcMMOSfv8GyswxWHjhEKGlyhcp4Yh4w=
=xg/j


-----END PGP SIGNATURE-----


   
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150603/0cfb7ffd/attachment.html>


More information about the OpenStack-docs mailing list