[OpenStack-docs] Cross-references between documents

Lana Brindley openstack at lanabrindley.com
Tue Jun 2 23:26:21 UTC 2015


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 03/06/15 09:19, Meg McRoberts wrote:
> Nice to see the beginnings of the Kilo doc!
> As I understand it, for Kilo, xrefs to docs in different repos are done with straight HTML references.So, right now, the URL is going to include "draft" -- for example, http://docs.openstack.org/kilo/config-reference/content/ch_configuring-openstack-image-service.html
> Will all these URLs be automatically converted when the Kilo docs are released or does someone need to go through and manuallysearch-and-replace?
> Thanks much!meg
>  
> 

Sorry Meg, I'm not sure I'm following here. If you're linking to a
Kilo-specific doc, then use http://docs.openstack.org/kilo/[bookname]/

Linking to the draft site isn't generally a good idea, and I would avoid
it if you can.

As for updating links, unless a permanent redirect is put in place, they
will need to be manually updated, but this is another really great
reason not to link to the draft site.

L


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

iQEcBAEBAgAGBQJVbjudAAoJELppzVb4+KUyFJIH/2KHunhOmMvRgKPUHrqDUPXd
pTLAYRKf4fXhuFUtmsrARKMBu1c+iGOTSOw1ADlhp56h2LWJVWYbtpUScNn87X4s
UEnDmfdsggrxeQiXofY6lgDd3mTsjdVyFJCMFj/g3yfIbZj9X32zN3qyO5YwrTFS
qTfxaEsEYMqZLkkncGuqxCXZw5IXtOEDfiM9ROUbp40h0qKEzAbXYJVIJlbT6sYB
pWQh6sDC+vHicloz35xA8ktle5q3K9Ik7SLACRRPB0EMydC/e/q4JwkCd+Uq4vrx
4XAfyITAXqjGvobqFVh7zzq0iEeT1nRtK7RZwcFqmamxc/LzEVBXsdBiknMFhJg=
=ENUZ
-----END PGP SIGNATURE-----



More information about the OpenStack-docs mailing list