Update/fix README links #4889

conniey · 2019-08-07T19:38:50Z

Updates links to source code to relative links. (This limits the breaking links if we decide we want to keep our libraries in some new folder.
Removes "en-us" from docs.microsoft.com links. This allows whatever locale the user has to be resolved (ie. mine is en-ca.)
Fixes broken Event Hubs README links.
Converts tabs to spaces

…om URLs.

g2vinay · 2019-08-07T19:54:11Z

sdk/identity/azure-identity/README.md

-	    .tenantId("<YOUR_TENANT_ID>")
-	    .build();
+        .clientId("<YOUR_CLIENT_ID>")
+        .clientSecret("<YOUR_CLIENT_SECRET>")


Is there some rule for indentation we should follow for code in READMEs?
Or just estimate it?

This used to be a tab. It was converted to spaces.

There was no indentation change. 1 tab = 4 spaces in our .editorconfig settings.

oh GIthub shows it like this, like some extra space added here.

Ahh, so before, they had one space, a tab character than then some spaces.

so, replacing tab with 4 spaces added extra space then ?

No. When you have a tab character, its rendered size depends on how large your tab size is. A tab size in our configuration is 4 spaces. So if you had a space then tab character, the tab character would only take up 3 spaces to fill in that first tab stop. If you had 0 spaces and pressed tab, it would take up the 4 spaces.

g2vinay

Changes look fine.
Would be good to verify relative links, post merge.

conniey · 2019-08-07T20:44:33Z

@g2vinay Here's a blog post to convince you. In addition, IntellIiJ tries to render these relative links and will show warnings if it cannot be resolved. That's how I found these in the first place.

https://github.blog/2013-01-31-relative-links-in-markup-files/

* Fixing link to storage and event hubs. * Fix broken links to Event Hubs. Convert tabs to spaces. * Use relative links to source code. Remove en-us from docs.microsoft.com URLs. * Remove en-us from identity/README.md

conniey added 3 commits August 7, 2019 12:28

Fixing link to storage and event hubs.

51c6c9c

Fix broken links to Event Hubs. Convert tabs to spaces.

a130d98

Use relative links to source code. Remove en-us from docs.microsoft.c…

2658eef

…om URLs.

conniey requested review from jianghaolu and g2vinay August 7, 2019 19:38

conniey requested review from hemanttanwar and samvaity as code owners August 7, 2019 19:38

conniey self-assigned this Aug 7, 2019

conniey requested a review from srnagar August 7, 2019 19:39

conniey added the Client This issue points to a problem in the data-plane of the library. label Aug 7, 2019

Remove en-us from identity/README.md

d4bf28e

g2vinay reviewed Aug 7, 2019

View reviewed changes

g2vinay approved these changes Aug 7, 2019

View reviewed changes

conniey merged commit 7e3d4a1 into Azure:master Aug 7, 2019

conniey deleted the fix-links branch August 7, 2019 20:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update/fix README links #4889

Update/fix README links #4889

conniey commented Aug 7, 2019 •

edited

Loading

g2vinay Aug 7, 2019

conniey Aug 7, 2019

conniey Aug 7, 2019

g2vinay Aug 7, 2019

conniey Aug 7, 2019

g2vinay Aug 7, 2019

conniey Aug 7, 2019

g2vinay left a comment

conniey commented Aug 7, 2019

Update/fix README links #4889

Update/fix README links #4889

Conversation

conniey commented Aug 7, 2019 • edited Loading

g2vinay Aug 7, 2019

Choose a reason for hiding this comment

conniey Aug 7, 2019

Choose a reason for hiding this comment

conniey Aug 7, 2019

Choose a reason for hiding this comment

g2vinay Aug 7, 2019

Choose a reason for hiding this comment

conniey Aug 7, 2019

Choose a reason for hiding this comment

g2vinay Aug 7, 2019

Choose a reason for hiding this comment

conniey Aug 7, 2019

Choose a reason for hiding this comment

g2vinay left a comment

Choose a reason for hiding this comment

conniey commented Aug 7, 2019

conniey commented Aug 7, 2019 •

edited

Loading