[WIP] aka.ms links to new azsdk scheme#8655
Conversation
| ## Key concepts | ||
|
|
||
| The [`AppConfigurationClient`](https://docs.microsoft.com/javascript/api/@azure/app-configuration/appconfigurationclient) has some terminology changes from App Configuration in the portal. | ||
| The [`AppConfigurationClient`](https://aka.ms/azsdk/js/docs/ref/app-configuration/appconfigurationclient) has some terminology changes from App Configuration in the portal. |
There was a problem hiding this comment.
Hmm, I can see doing this for type/method docs would require us to create and maintain many aka.ms links. I feel it would be fine to only use aka.ms links for landing pages but would like to know what others think.
There was a problem hiding this comment.
Yea, good question. @jongio I think you wanted to keep these links just for general docs, this many layers deep seems to be a bit much and a pain to maintain
There was a problem hiding this comment.
I think we should do one for each landing page.
There was a problem hiding this comment.
Do you mind providing some guidance on the naming of the links for these landing pages? The one referenced in this thread happened automatically.
There was a problem hiding this comment.
I confirmed with Jeremy and I will proceed to focus on links like:
[API reference documentation](https://aka.ms/azsdk/js/docs/ref/app-configuration)
Not like:
[`AppConfigurationClient`](https://aka.ms/azsdk/js/docs/ref/app-configuration/appconfigurationclient)
There was a problem hiding this comment.
So this will be for general ref docs but not for that particular client, right? Will you keep the links for client the way they were before?
There was a problem hiding this comment.
Ok, latest directions: Jon says that docs.microsoft.com don't need aka . I'll only do aka links to non-docs.microsoft links.
There was a problem hiding this comment.
@kaerm Hi! I will be making a new PR and closing this one. I believe this list gets closer to those links that should be moved to aka.ms: https://gist.github.com/sadasant/7f4f00f433577b66fd016136c4312e7e Do you mind helping me know if this list is correct? or if I could narrow it even further? I will do the PR from your feedback, for sure.
There was a problem hiding this comment.
So you are planning to aka.ms the links in that list, correct?
There was a problem hiding this comment.
@kaerm yep! I'm doing other things, but I will get back to this asap.
| [Source code](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/) | | ||
| [Package (NPM)](https://www.npmjs.com/package/@azure/app-configuration) | | ||
| [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/app-configuration) | | ||
| [API reference documentation](https://aka.ms/azsdk/js/docs/ref/app-configuration) | |
There was a problem hiding this comment.
Why are we creating this as an aka? If the doc links right to docs.microsoft.com, then I don't see a need for an aka. I've only been using akas for links that point off plat, like GH pages.
There was a problem hiding this comment.
@jongio Hi! I will be making a new PR and closing this one. I believe this list gets closer to those links that should be moved to aka.ms: https://gist.github.com/sadasant/7f4f00f433577b66fd016136c4312e7e Do you mind helping me know if this list is correct? or if I could narrow it even further? I will do the PR from your feedback, for sure.
|
I will be closing this PR on favor of another one later today, since the work that needs to be done is considerably different than the work portrayed in this PR. |
|
I'm narrowing this down, but I won't be able to make a follow-up PR today. |
|
Closing this on favor of: #9034 |
So far I've pretty much executed:
I will also be replacing matches for these links:
TODO:
I wonder, what other patterns should I be checking against?
Thank you for your time!
Fixes #8516