-
Notifications
You must be signed in to change notification settings - Fork 121
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
Replaced relative link with absolute links and remove locale #1296
Changes from 3 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 |
---|---|---|
|
@@ -16,7 +16,7 @@ With this in mind, there are many tenets or principles that we follow in order t | |
|
||
- 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. | ||
|
||
## Table of Contents | ||
|
||
|
@@ -63,8 +63,8 @@ To get help with the SDK: | |
|
||
The Azure SDK for Embedded C repo has been structured around the service libraries it provides: | ||
|
||
1. [IoT](sdk/docs/iot) - Library to connect Embedded Devices to Azure IoT services | ||
2. [Storage](sdk/docs/storage) - Library to send blob files to Azure IoT services | ||
1. [IoT](https://github.com/Azure/azure-sdk-for-c/blob/master/sdk/docs/iot) - Library to connect Embedded Devices to Azure IoT services | ||
2. [Storage](https://github.com/Azure/azure-sdk-for-c/blob/master/sdk/docs/storage) - Library to send blob files to Azure IoT services | ||
|
||
### Structure | ||
|
||
|
@@ -113,7 +113,7 @@ The SDK can be conveniently consumed either via CMake or other non-CMake methods | |
|
||
git checkout <tag_name> | ||
|
||
For information about using a specific client library, see the README file located in the client library's folder which is a subdirectory under the [`/sdk/docs`](sdk/docs) folder. | ||
For information about using a specific client library, see the README file located in the client library's folder which is a subdirectory under the [`/sdk/docs`](https://github.com/Azure/azure-sdk-for-c/blob/master/sdk/docs) folder. | ||
|
||
3. Ensure the SDK builds correctly. | ||
|
||
|
@@ -242,7 +242,7 @@ The following compilation, preprocessor options will add or remove functionality | |
|
||
See [cmake options](#cmake-options) to learn about how to build samples with HTTP implementation in order to be runnable. | ||
|
||
After building samples with HTTP stack, set the environment variables for credentials. The samples read these environment values to authenticate to Azure services. See [client secret here](https://docs.microsoft.com/en-us/azure/active-directory/azuread-dev/v1-oauth2-on-behalf-of-flow#service-to-service-access-token-request) for additional details on Azure authentication. | ||
After building samples with HTTP stack, set the environment variables for credentials. The samples read these environment values to authenticate to Azure services. See [client secret here](https://docs.microsoft.com/azure/active-directory/azuread-dev/v1-oauth2-on-behalf-of-flow#service-to-service-access-token-request) for additional details on Azure authentication. | ||
|
||
```bash | ||
# On linux, set env var like this. For Windows, do it from advanced settings/ env variables | ||
|
@@ -280,7 +280,7 @@ files and start again. | |
vcpkg is the easiest way to have dependencies installed. It downloads packages sources, headers and build libraries for whatever TRIPLET is set up (platform/arq). | ||
VCPKG maintains any installed package inside its own folder, allowing to have multiple vcpkg folder with different dependencies installed on each. This is also great because you don't have to install dependencies globally on your system. | ||
|
||
Follow next steps to install VCPKG and have it linked to cmake. The vcpkg repository is checked out at the commit in [vcpkg-commit.txt](eng/vcpkg-commit.txt). Azure SDK code in this version is known to work at that vcpkg ref. | ||
Follow next steps to install VCPKG and have it linked to cmake. The vcpkg repository is checked out at the commit in [vcpkg-commit.txt](https://github.com/Azure/azure-sdk-for-c/blob/master/eng/vcpkg-commit.txt). Azure SDK code in this version is known to work at that vcpkg ref. | ||
|
||
```bash | ||
# Clone vcpkg: | ||
|
@@ -332,7 +332,7 @@ Right after opening project, Visual Studio will read cmake files and generate ca | |
VCPKG can be used to download packages sources, headers and build libraries for whatever TRIPLET is set up (platform/architecture). | ||
VCPKG maintains any installed package inside its own folder, allowing to have multiple vcpkg folder with different dependencies installed on each. This is also great because you don't have to install dependencies globally on your system. | ||
|
||
Follow next steps to install VCPKG and have it linked to cmake. Follow next steps to install VCPKG and have it linked to cmake. The vcpkg repository is checked out at the commit in [vcpkg-commit.txt](eng/vcpkg-commit.txt). Azure SDK code in this version is known to work at that vcpkg ref. | ||
Follow next steps to install VCPKG and have it linked to cmake. Follow next steps to install VCPKG and have it linked to cmake. The vcpkg repository is checked out at the commit in [vcpkg-commit.txt](https://github.com/Azure/azure-sdk-for-c/blob/master/eng/vcpkg-commit.txt). Azure SDK code in this version is known to work at that vcpkg ref. | ||
|
||
```bash | ||
# Clone vcpkg: | ||
|
@@ -389,7 +389,7 @@ First, ensure that you have the latest `gcc` installed: | |
brew install gcc | ||
brew cleanup | ||
|
||
Follow next steps to install VCPKG and have it linked to cmake. Follow next steps to install VCPKG and have it linked to cmake. The vcpkg repository is checked out at the commit in [vcpkg-commit.txt](eng/vcpkg-commit.txt). Azure SDK code in this version is known to work at that vcpkg ref. | ||
Follow next steps to install VCPKG and have it linked to cmake. Follow next steps to install VCPKG and have it linked to cmake. The vcpkg repository is checked out at the commit in [vcpkg-commit.txt](https://github.com/Azure/azure-sdk-for-c/blob/master/eng/vcpkg-commit.txt). Azure SDK code in this version is known to work at that vcpkg ref. | ||
|
||
```bash | ||
# Clone vcpkg: | ||
|
@@ -454,7 +454,7 @@ See the complete cmake file and how to link your own library [here](https://gith | |
|
||
## 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: | ||
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. Question: Why do we prefer 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. 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 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. 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. |
||
|
||
- **Spans**: A span represents a byte buffer and is used for string manipulations, HTTP requests/responses, reading/writing JSON payloads. It allows us to return a substring within a larger string without any memory allocations. See the [Working With Spans](https://github.com/Azure/azure-sdk-for-c/tree/master/sdk/docs/core#working-with-spans) section of the `Azure Core` README for more information. | ||
|
||
|
@@ -472,7 +472,7 @@ In addition to the above features, `Azure Core` provides features available to c | |
|
||
## Contributing | ||
|
||
For details on contributing to this repository, see the [contributing guide](CONTRIBUTING.md). | ||
For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-c/blob/master/CONTRIBUTING.md). | ||
|
||
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit [https://cla.microsoft.com](https://cla.microsoft.com). | ||
|
||
|
@@ -487,8 +487,8 @@ For more information see the [Code of Conduct FAQ](https://opensource.microsoft. | |
Many people all over the world have helped make this project better. You'll want to check out: | ||
|
||
- [What are some good first issues for new contributors to the repo?](https://github.com/azure/azure-sdk-for-c/issues?q=is%3Aopen+is%3Aissue+label%3A%22up+for+grabs%22) | ||
- [How to build and test your change](./CONTRIBUTING.md#developer-guide) | ||
- [How you can make a change happen!](./CONTRIBUTING.md#pull-requests) | ||
- [How to build and test your change](https://github.com/Azure/azure-sdk-for-c/blob/master/CONTRIBUTING.md#developer-guide) | ||
- [How you can make a change happen!](https://github.com/Azure/azure-sdk-for-c/blob/master/CONTRIBUTING.md#pull-requests) | ||
|
||
### Community | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,7 +16,7 @@ Many SDK functions return an `az_result` as defined in [inc/az_result.h](https:/ | |
|
||
### Working with Spans | ||
|
||
An `az_span` is a small data structure (defined in our [az_span.h](../../../sdk/inc/azure/core/az_span.h) file) wrapping a byte buffer. Specifically, an `az_span` instance contains: | ||
An `az_span` is a small data structure (defined in our [az_span.h](https://github.com/Azure/azure-sdk-for-c/blob/master/sdk/inc/azure/core/az_span.h) file) wrapping a byte buffer. Specifically, an `az_span` instance contains: | ||
|
||
- a byte pointer | ||
- an integer size | ||
|
@@ -72,7 +72,7 @@ There are many functions to manipulate `az_span` instances. You can slice (subse | |
|
||
### Strings | ||
|
||
A string is a span of UTF-8 characters. It's not a zero-terminated string. Defined in [inc/az_span.h](../../../sdk/inc/azure/core/az_span.h). | ||
A string is a span of UTF-8 characters. It's not a zero-terminated string. Defined in [inc/az_span.h](https://github.com/Azure/azure-sdk-for-c/blob/master/sdk/inc/azure/core/az_span.h). | ||
|
||
```c | ||
az_span hello_world = AZ_SPAN_FROM_STR("Hello world!"); | ||
|
@@ -162,7 +162,7 @@ If you'd like to contribute to this library, please read the [contributing guide | |
Azure SDK for Embedded C is licensed under the [MIT][azure_sdk_for_c_license] license. | ||
|
||
<!-- LINKS --> | ||
[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 | ||
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. What about these links? 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 suspect these were not flagged because they are not referenced anywhere in the MD file. They should probably be removed. |
||
[azure_sdk_for_c_contributing_pull_requests]: ../../../CONTRIBUTING.md#pull-requests | ||
|
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.
Good catch.