GitHub Relative Links do not work on docs.microsoft.com/samples

[willmtemple]

When our readme pages are generated from the markdown for ingestion into docs.microsoft.com, relative links are not made relative to the document's location on github (as they would be if they were displayed here on github). Instead, they convert into broken links that are relative to the page on docs.microsoft.com.

See this example : https://docs.microsoft.com/en-us/samples/azure/azure-sdk-for-js/keyvault-certificates-typescript/

... in which the purgeAllCertificates.ts link is broken.

Seems that we have to take extra care to make sure link URI's in material that is rendered through docs.microsoft.com/samples are absolute.

[ramya-rao-a]

@willmtemple Is the action item here that we need to have all the readmes reviewed?
@czubair Is this something you can add to the doc review checklist you have for each release?

[willmtemple]

@ramya-rao-a the whole situation with links on README files is weird. We really probably want to use links that are tagged to a specific commit when anything is published to docs.microsoft.com, but I don't think that functionality exists.

For now, I've used a regular expression to find files that have relative links in the markdown files:

⇒  rg -lg "sdk/*/*/samples/*/README.md" "\]: \."
sdk/keyvault/keyvault-keys/samples/javascript/README.md
sdk/keyvault/keyvault-keys/samples/typescript/README.md
sdk/keyvault/keyvault-secrets/samples/typescript/README.md
sdk/keyvault/keyvault-secrets/samples/javascript/README.md
sdk/keyvault/keyvault-certificates/samples/javascript/README.md
sdk/keyvault/keyvault-certificates/samples/typescript/README.md

A bunch of the package READMEs also have relative links, but they are handled correctly by NPM and don't show up on docs.microsoft.com as far as I can tell.

[weshaggard]

Related to Azure/azure-sdk#1214.

[ramya-rao-a]

Thanks @weshaggard

@willmtemple, am closing this issue in favor of the upstream one