Skip to content

[WIP] aka.ms links to new azsdk scheme#8655

Closed
sadasant wants to merge 4 commits intoAzure:masterfrom
sadasant:fix8516
Closed

[WIP] aka.ms links to new azsdk scheme#8655
sadasant wants to merge 4 commits intoAzure:masterfrom
sadasant:fix8516

Conversation

@sadasant
Copy link
Copy Markdown
Contributor

@sadasant sadasant commented May 1, 2020

So far I've pretty much executed:

find . -type f -exec sed -i 's/docs.microsoft.com\/javascript\/api\/\@azure/aka.ms\/azsdk\/js\/docs\/ref/g' {} \;

I will also be replacing matches for these links:

aka.ms/azsdk-js-formrecognizer-ref-docs
aka.ms/azsdk-js-search-ref-docs
aka.ms/azsdk-js-textanalytics-ref-docs

TODO:

  • Actually make the links (Kate taught me how to do it!, just go to aka.ms 😉).

I wonder, what other patterns should I be checking against?

Thank you for your time!

Fixes #8516

@sadasant sadasant requested review from jeremymeng and jongio May 1, 2020 19:36
@sadasant sadasant self-assigned this May 1, 2020
@sadasant sadasant requested a review from kaerm May 1, 2020 19:47
## 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.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The 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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should do one for each landing page.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The 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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The 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:

[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)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The 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?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, latest directions: Jon says that docs.microsoft.com don't need aka . I'll only do aka links to non-docs.microsoft links.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The 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?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The 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.

[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) |
Copy link
Copy Markdown
Member

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.

Copy link
Copy Markdown
Contributor Author

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.

@sadasant
Copy link
Copy Markdown
Contributor Author

sadasant commented May 5, 2020

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.

@sadasant
Copy link
Copy Markdown
Contributor Author

sadasant commented May 5, 2020

I'm narrowing this down, but I won't be able to make a follow-up PR today.

@sadasant
Copy link
Copy Markdown
Contributor Author

Closing this on favor of: #9034

@sadasant sadasant closed this May 20, 2020
@sadasant sadasant deleted the fix8516 branch May 26, 2020 11:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Move aka.ms links to new azsdk scheme

4 participants