-
Notifications
You must be signed in to change notification settings - Fork 1.4k
[WIP] aka.ms links to new azsdk scheme #8655
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,7 +10,7 @@ Use the client library for App Configuration to: | |
|
|
||
| [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) | | ||
| [Product documentation](https://docs.microsoft.com/en-us/azure/azure-app-configuration/) | | ||
| [Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/appconfiguration/app-configuration/samples) | ||
|
|
||
|
|
@@ -80,12 +80,12 @@ const client = new AppConfigurationClient("<connection string>"); | |
|
|
||
| ## 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. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we should do one for each landing page.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do you mind providing some guidance on the naming of the links for these landing pages? The one referenced in this thread happened automatically.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I confirmed with Jeremy and I will proceed to focus on links like: Not like:
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ok, latest directions: Jon says that
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @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.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. So you are planning to aka.ms the links in that list, correct?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @kaerm yep! I'm doing other things, but I will get back to this asap. |
||
|
|
||
| - Key/Value pairs are represented as [`ConfigurationSetting`](https://docs.microsoft.com/javascript/api/@azure/app-configuration/configurationsetting) objects | ||
| - Key/Value pairs are represented as [`ConfigurationSetting`](https://aka.ms/azsdk/js/docs/ref/app-configuration/configurationsetting) objects | ||
| - Locking and unlocking a setting is represented in the `isReadOnly` field, which you can toggle using `setReadOnly`. | ||
|
|
||
| The client follows a simple design methodology - [`ConfigurationSetting`](https://docs.microsoft.com/javascript/api/@azure/app-configuration/configurationsetting) can be passed into any method that takes a [`ConfigurationSettingParam`](https://docs.microsoft.com/javascript/api/@azure/app-configuration/configurationsettingparam) or [`ConfigurationSettingId`](https://docs.microsoft.com/javascript/api/@azure/app-configuration/configurationsettingid). | ||
| The client follows a simple design methodology - [`ConfigurationSetting`](https://aka.ms/azsdk/js/docs/ref/app-configuration/configurationsetting) can be passed into any method that takes a [`ConfigurationSettingParam`](https://aka.ms/azsdk/js/docs/ref/app-configuration/configurationsettingparam) or [`ConfigurationSettingId`](https://aka.ms/azsdk/js/docs/ref/app-configuration/configurationsettingid). | ||
|
|
||
| This means this pattern works: | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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.