Replaced relative link with absolute links and remove locale by sima-zhu · Pull Request #1296 · Azure/azure-sdk-for-c

sima-zhu · 2020-09-17T23:01:02Z

The PR is to turn on the link check flag.

Disable the relative links.
Remove locale "en-us" from link.

ahsonkhan

Revert SECURITY.md changes. Otherwise, looks good.

ahsonkhan · 2020-09-18T00:24:45Z

 - Unlike our other language SDKs, many things (such as composing an HTTP pipeline of policies) are done in source code as opposed to runtime. This reduces code size, improves execution speed and locks-in behavior, reducing the chance of bugs at runtime.

- We support microcontrollers with no operating system, microcontrollers with a real-time operating system (like [Azure RTOS](https://azure.microsoft.com/en-us/services/rtos/)), Linux, and Windows. Customers can implement custom platform layers to use our SDK on custom devices.  We provide some platform layers, and encourage the community to submit platform layers to increase the out-of-the-box supported platforms.
+- We support microcontrollers with no operating system, microcontrollers with a real-time operating system (like [Azure RTOS](https://azure.microsoft.com/services/rtos/)), Linux, and Windows. Customers can implement custom platform layers to use our SDK on custom devices.  We provide some platform layers, and encourage the community to submit platform layers to increase the out-of-the-box supported platforms.


Good catch.

ahsonkhan · 2020-09-18T00:26:35Z

 ## SDK Architecture

-At the heart of our SDK is, what we refer to as, [Azure Core](https://github.com/Azure/azure-sdk-for-c/tree/master/sdk/docs/core). This code defines several data types and functions for use by the client libraries that build on top of us such as an [Azure Storage Blob](https://github.com/Azure/azure-sdk-for-c/tree/master/sdk/docs/storage) client library and [Azure IoT client libraries](https://github.com/Azure/azure-sdk-for-c/tree/master/sdk/docs/iot). Here are some of the features that customers use directly:
+At the heart of our SDK is, what we refer to as, [Azure Core](https://github.com/Azure/azure-sdk-for-c/tree/master/sdk/docs/core). This code defines several data types and functions for use by the client libraries that build on top of us such as an [Azure Storage Blob](https://github.com/Azure/azure-sdk-for-c/blob/master/sdk/docs/storage) client library and [Azure IoT client libraries](https://github.com/Azure/azure-sdk-for-c/blob/master/sdk/docs/iot). Here are some of the features that customers use directly:


Question: Why do we prefer /blob/ over /tree/?

Actually, github link is able to switch each other when necessary. I am using a script to do the replacement, so I just choose one of them as I feel like blob is used more often than tree. Just personal feeling

In general blob should be used for files and tree should be used for directories but github usually forwards any blob requests that point to a directory to tree.

ahsonkhan · 2020-09-18T00:28:14Z

 ## Policy

-Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
+Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/msrc/cvd).


The SECURITY.md content is the verbatim text all new repos are getting seeded with (there's a comment tag at the top and bottom of the file indicating the text version).

For now, please revert the changes to this file.

If we revert this the checks will fail. I think we should go ahead and update this as the link is definitely incorrect.

ahsonkhan · 2020-09-18T00:28:51Z

-[azure_sdk_for_c_contributing]: ../../../CONTRIBUTING.md
+[azure_sdk_for_c_contributing]: https://github.com/Azure/azure-sdk-for-c/blob/master/CONTRIBUTING.md
 [azure_sdk_for_c_license]: https://github.com/Azure/azure-sdk-for-c/blob/master/LICENSE
 [azure_sdk_for_c_contributing_developer_guide]: ../../../CONTRIBUTING.md#developer-guide


What about these links?

I suspect these were not flagged because they are not referenced anywhere in the MD file. They should probably be removed.

ahsonkhan · 2020-09-18T00:31:11Z

 ### License

-Azure SDK for Embedded C is licensed under the [MIT][azure_sdk_for_c_license] license.
+Azure SDK for Embedded C is licensed under the [MIT][azure_sdk_for_c_license] license.


What's the change here?

it's a ghost character!

I am wondering the same

Is it a line-ending changed from CRLF to LF or vice versa? You can use hexdump to see the exact byte contents of the file and that will show you the difference:
https://www.fileformat.info/tool/hexdump.htm

I bet it's a new line at the end of the file.

"> \ No newline at end of file
+Azure SDK for Embedded C is licensed under the [MIT][azure_sdk_for_c_license] license.
"

Was in the email.

except now this is all obsolete because I just merged in a change to this same file... Hopefully it's not much extra work for you!

momuno · 2020-09-18T00:45:40Z

awesome, thanks for the cleanup!

weshaggard · 2020-09-18T02:41:20Z

 [azure_pattern_retry]: https://docs.microsoft.com/azure/architecture/patterns/retry
-[azure_sdk_for_c_contributing]: ../../../CONTRIBUTING.md
+[azure_sdk_for_c_contributing]: https://github.com/Azure/azure-sdk-for-c/blob/master/CONTRIBUTING.md
 [azure_sdk_for_c_contributing_developer_guide]: ../../../CONTRIBUTING.md#developer-guide


These also look to be unused.

Right, that's why we did not fetch them out. Thanks! I will fix it for now.

weshaggard

A couple of unused links but otherwise looks good.

This is the final step of link verification epic. Enable the link guidance check for all Ci pipelines. The PR is pending for all lang PRs: java: Azure/azure-sdk-for-java#15285 net: Azure/azure-sdk-for-net#15223 python: Azure/azure-sdk-for-python#13846 js: Azure/azure-sdk-for-js#11317 ios: Azure/azure-sdk-for-ios#433 android: Azure/azure-sdk-for-android#348 go: Azure/azure-sdk-for-go#12541 cpp: Azure/azure-sdk-for-cpp#632 c: Azure/azure-sdk-for-c#1296

sima-zhu requested review from a team, CIPop, RickWinter, ahsonkhan, antkmsft, danewalton-msft, danieljurek, ericwolz, ewertons, hihigupt, joshfree, jspaith, momuno and vhvb1989 as code owners September 17, 2020 23:01

sima-zhu force-pushed the disable_relative_links branch 2 times, most recently from ddca5bc to c68d3c0 Compare September 17, 2020 23:16

sima-zhu mentioned this pull request Sep 17, 2020

Enable the link check for link verification step. Azure/azure-sdk-tools#1019

Merged

ahsonkhan assigned sima-zhu Sep 18, 2020

ahsonkhan added the EngSys This issue is impacting the engineering system. label Sep 18, 2020

ahsonkhan added this to the [2020] October milestone Sep 18, 2020

ahsonkhan reviewed Sep 18, 2020

View reviewed changes

ahsonkhan approved these changes Sep 18, 2020

View reviewed changes

momuno approved these changes Sep 18, 2020

View reviewed changes

Revert the security changes

3129e02

sima-zhu force-pushed the disable_relative_links branch from a138053 to 3129e02 Compare September 18, 2020 00:54

sima-zhu and others added 2 commits September 17, 2020 18:05

Enable the feature on client yml

a840cb7

Merge branch 'master' into disable_relative_links

f1b8624

weshaggard reviewed Sep 18, 2020

View reviewed changes

weshaggard approved these changes Sep 18, 2020

View reviewed changes

sima-zhu added 2 commits September 17, 2020 19:47

Address feedback

3a80813

remove locale

5c151c9

sima-zhu merged commit 91f310b into Azure:master Sep 18, 2020

sima-zhu deleted the disable_relative_links branch September 18, 2020 03:57

sima-zhu restored the disable_relative_links branch September 18, 2020 04:13

sima-zhu deleted the disable_relative_links branch September 18, 2020 04:14

Conversation

sima-zhu commented Sep 17, 2020

Uh oh!

ahsonkhan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

momuno commented Sep 18, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

weshaggard left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants