Azure / azure-sdk-for-js

This repository is for active development of the Azure SDK for JavaScript (NodeJS & Browser). For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/javascript/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-js.
MIT License
2.1k stars 1.21k forks source link

Move aka.ms links to new azsdk scheme #8516

Closed jeremymeng closed 4 years ago

jeremymeng commented 4 years ago

Guidance provided by @jongio in internal Teams post

These will be updated to the pattern: "azsdk/{lang}/docs/ref/{service}" after the aka.ms links are public

jeremymeng commented 4 years ago

This is specific to standardize the aka.ms links for our sdk libraries. We might need to create links if they don't exist yet.

sadasant commented 4 years ago

@jeremymeng these are all of the aka.ms links we use in our repository (I have sorted them and removed duplicates):

aka.ms/AzureSDKBundling
aka.ms/autorest
aka.ms/azsdk-js
aka.ms/azsdk-js-formrecognizer-ref-docs
aka.ms/azsdk-js-search-ref-docs
aka.ms/azsdk-js-textanalytics-ref-docs
aka.ms/azure-cli
aka.ms/azure-sdk-preview1-js
aka.ms/cosmos-consistency
aka.ms/cosmosdb-emulator
aka.ms/downloadazcopy-v10-windows
aka.ms/iotmsgenrich
aka.ms/js-docs
aka.ms/mdssewithcmkoverview
aka.ms/mesformats
aka.ms/sfhealthid
aka.ms/supportAPI
aka.ms/supportrpquotarequestpayload
aka.ms/talangs
aka.ms/taner
aka.ms/tanerpii
aka.ms/textClassifyCategories

I am confused. What do I do with these? Some of them seem to be fine.

sadasant commented 4 years ago

Jeremy said that we should be fine by limiting this work to fix the API reference documentation links. For example, for storage-blob, who has this in the README:

[API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/storage-blob)

Should end up like:

[API Reference Documentation](https://aka.ms/azsdk/javascript/docs/ref/storage-blob)

For the links that don't work, I should get in touch with Kate.

jongio commented 4 years ago

We are using the following for langs: I updated the doc:

"azsdk/(js|net|java|python|go)/docs/ref/{service}"

so change "javascript" to js.

Thanks

sadasant commented 4 years ago

@jongio hey! Thank you!!!