Update the root readme #1732
Open
Update the root readme #1732
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
LarryOsterman
approved these changes
Aug 2, 2024
|
|
||
| ## Crates | ||
| * [Overview of Azure SDK for Rust](https://docs.microsoft.com/azure/developer/rust/) | ||
| * [SDK Reference](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk) |
| @@ -25,28 +35,27 @@ Azure service crates generated from [Azure REST API Specifications](https://gith | |||
|
|
|||
| 🚨 WARNING 🚨: This project is under active development. Be aware that large breaking changes will happen before 1.0 is reached. | |||
|
|
|||
| ### Historical releases | |||
|
|
|||
| This project is the successor to the `azure_sdk*` crates from [MindFlavor/AzureSDKForRust](https://github.com/MindFlavor/AzureSDKForRust). The crates have been renamed, so those older crates should be considered fully deprecated. See [history](HISTORY.md) for more details. | |||
There was a problem hiding this comment.
Do you also want to include a link to the legacy branch holding the unofficial Azure SDK Releases?
There was a problem hiding this comment.
We haven't migrated yet and I don't think we should until we're ready to migrate feature/track2 to main. People are still actively contributing to main. I think at that time this README should reflect that information, though, yes.
|
This made me realize we'll need to have Rust included in the release CSV automation that's used to populate the releases site and to start looking into our Docs space. |
heaths
approved these changes
Aug 2, 2024
| @@ -1,22 +1,32 @@ | |||
| # Azure SDK for Rust | |||
|
|
|||
| This repository is for the development of the [unofficial](https://github.com/Azure/azure-sdk-for-rust/blob/main/FAQ.md#why-is-it-unofficial) Azure SDK for Rust. | |||
| This repository is for the active development of the Azure SDK for Rust. For consumers of the SDK you can follow the links below to visit the documentation you are interested in | |||
There was a problem hiding this comment.
Punctuation:
Suggested change
| This repository is for the active development of the Azure SDK for Rust. For consumers of the SDK you can follow the links below to visit the documentation you are interested in | |
| This repository is for the active development of the Azure SDK for Rust. For consumers of the SDK you can follow the links below to visit the documentation you are interested in. |
|
|
||
| ## Crates available | ||
|
|
||
| Each service can have both 'client' and 'management' crates. 'Client' crates are used to consume the service, whereas 'management' crates are used to configure and manage the service. |
There was a problem hiding this comment.
It may be first in a sentence, but the casing is specific. You can fix it with a colon.
Suggested change
| Each service can have both 'client' and 'management' crates. 'Client' crates are used to consume the service, whereas 'management' crates are used to configure and manage the service. | |
| Each service can have both 'client' and 'management' crates: 'client' crates are used to consume the service, whereas 'management' crates are used to configure and manage the service. |
| - [azure_storage_queues](https://crates.io/crates/azure_storage_queues) | ||
| ### Client modules | ||
|
|
||
| Our client crates follow the [Azure Rust SDK guidelines](https://azure.github.io/azure-sdk/rust_introduction.html). These crates allow you to use, consume, and interact with existing resources, for example, uploading a blob. They also share a number of core functionalities including retries, logging, transport protocols, authentication protocols, etc. that can be found in the [azure_identity](https://crates.io/crates/azure_identity) module. |
There was a problem hiding this comment.
Consistency and punctuation:
Suggested change
| Our client crates follow the [Azure Rust SDK guidelines](https://azure.github.io/azure-sdk/rust_introduction.html). These crates allow you to use, consume, and interact with existing resources, for example, uploading a blob. They also share a number of core functionalities including retries, logging, transport protocols, authentication protocols, etc. that can be found in the [azure_identity](https://crates.io/crates/azure_identity) module. | |
| Our crates follow the [Azure SDK for Rust guidelines](https://azure.github.io/azure-sdk/rust_introduction.html). These crates allow you to use, consume, and interact with existing resources; for example, uploading a blob. They also share a number of core functionalities including retries, logging, transport protocols, authentication protocols, etc. that can be found in the [azure_identity](https://crates.io/crates/azure_identity) crate. |
|
|
||
| Our client crates follow the [Azure Rust SDK guidelines](https://azure.github.io/azure-sdk/rust_introduction.html). These crates allow you to use, consume, and interact with existing resources, for example, uploading a blob. They also share a number of core functionalities including retries, logging, transport protocols, authentication protocols, etc. that can be found in the [azure_identity](https://crates.io/crates/azure_identity) module. | ||
|
|
||
| You can find the most up-to-date list of new modules on our [latest page](https://azure.github.io/azure-sdk/releases/latest/index.html#rust). |
There was a problem hiding this comment.
Translates better, if ever important:
Suggested change
| You can find the most up-to-date list of new modules on our [latest page](https://azure.github.io/azure-sdk/releases/latest/index.html#rust). | |
| You can find the most recent list of new crates on our [latest releases page](https://azure.github.io/azure-sdk/releases/latest/index.html#rust). |
Also, stop calling them "modules". This isn't Go. 😄
| @@ -25,28 +35,27 @@ Azure service crates generated from [Azure REST API Specifications](https://gith | |||
|
|
|||
| 🚨 WARNING 🚨: This project is under active development. Be aware that large breaking changes will happen before 1.0 is reached. | |||
|
|
|||
| ### Historical releases | |||
|
|
|||
| This project is the successor to the `azure_sdk*` crates from [MindFlavor/AzureSDKForRust](https://github.com/MindFlavor/AzureSDKForRust). The crates have been renamed, so those older crates should be considered fully deprecated. See [history](HISTORY.md) for more details. | |||
There was a problem hiding this comment.
We haven't migrated yet and I don't think we should until we're ready to migrate feature/track2 to main. People are still actively contributing to main. I think at that time this README should reflect that information, though, yes.
Comment on lines
+48
to
+49
| * File an issue via [Github Issues](https://github.com/Azure/azure-sdk-for-rust/issues) | ||
| * Check [previous questions](https://stackoverflow.com/questions/tagged/azure+rust) or ask new ones on StackOverflow using `azure` and `rust` tags. |
There was a problem hiding this comment.
I think the order shouild be reversed. It's an unordered list, sure, but there's an implied order there. Also, there is a space in "Stack Overflow". It's a product name and should be referenced properly. GitHub also has a capital "G" and "H".
Suggested change
| * File an issue via [Github Issues](https://github.com/Azure/azure-sdk-for-rust/issues) | |
| * Check [previous questions](https://stackoverflow.com/questions/tagged/azure+rust) or ask new ones on StackOverflow using `azure` and `rust` tags. | |
| * Check [previous questions](https://stackoverflow.com/questions/tagged/azure+rust) or ask new ones on Stack Overflow using `azure` and `rust` tags. | |
| * File an issue via [GitHub Issues](https://github.com/Azure/azure-sdk-for-rust/issues) |
Comment on lines
+51
to
+53
| ## Community | ||
|
|
||
| This library comes with a testing framework that executes against prerecorded sessions to quickly validate code changes without incurring in Azure costs. You can read more about it in the [Mock testing framework's README](https://github.com/Azure/azure-sdk-for-rust/tree/feature/track2/doc/mock_transport.md). | ||
| ## Contribute |
There was a problem hiding this comment.
Empty heading.
We should put information that was here in a CONTRIBUTING.md at some point.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Restructure the root repo to be inline with other languages.