From 622712058f0f7fcfd7383dc12289e64afba68e39 Mon Sep 17 00:00:00 2001 From: Bin Liu Date: Mon, 21 Mar 2022 23:20:25 +0800 Subject: [PATCH] Fix developer guide URL (#1262) * Update README.md to fix invalid Developer Guide URL The old guide: https://github.com/awslabs/aws-sdk-rust/blob/main/Guide.md has been deleted and changed to: https://docs.aws.amazon.com/sdk-for-rust/latest/dg/welcome.html See: https://github.com/awslabs/aws-sdk-rust/pull/325 Signed-off-by: bin liu * Update invalid Developer Guide URL in AwsReadmeDecorator.kt The old guide: https://github.com/awslabs/aws-sdk-rust/blob/main/Guide.md has been deleted and changed to: https://docs.aws.amazon.com/sdk-for-rust/latest/dg/welcome.html See: https://github.com/awslabs/aws-sdk-rust/pull/325 Signed-off-by: bin liu * Add fixing Developer Guide link to CHANGELOG.next.toml Signed-off-by: bin liu Co-authored-by: Russell Cohen --- CHANGELOG.next.toml | 12 ++++++++++++ aws/rust-runtime/aws-config/README.md | 2 +- .../amazon/smithy/rustsdk/AwsReadmeDecorator.kt | 2 +- 3 files changed, 14 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.next.toml b/CHANGELOG.next.toml index 72d79628e..a820b90ca 100644 --- a/CHANGELOG.next.toml +++ b/CHANGELOG.next.toml @@ -10,3 +10,15 @@ # references = ["smithy-rs#920"] # meta = { "breaking" = false, "tada" = false, "bug" = false } # author = "rcoh" + +[[smithy-rs]] +message = "Fix link to Developer Guide in crate's README.md" +references = ["smithy-rs#1262"] +meta = { "breaking" = false, "tada" = false, "bug" = false } +author = "liubin" + +[[aws-sdk-rust]] +message = "Fix link to Developer Guide in crate's README.md" +references = ["smithy-rs#1262"] +meta = { "breaking" = false, "tada" = false, "bug" = false } +author = "liubin" diff --git a/aws/rust-runtime/aws-config/README.md b/aws/rust-runtime/aws-config/README.md index d14eff558..dde5c865a 100644 --- a/aws/rust-runtime/aws-config/README.md +++ b/aws/rust-runtime/aws-config/README.md @@ -46,7 +46,7 @@ tokio = { version = "1", features = ["full"] } ## Using the SDK -Until the SDK is released, we will be adding information about using the SDK to the [Guide]. Feel free to suggest additional sections for the guide by opening an issue and describing what you are trying to do. +Until the SDK is released, we will be adding information about using the SDK to the [Developer Guide](https://docs.aws.amazon.com/sdk-for-rust/latest/dg/welcome.html). Feel free to suggest additional sections for the guide by opening an issue and describing what you are trying to do. ## Getting Help diff --git a/aws/sdk-codegen/src/main/kotlin/software/amazon/smithy/rustsdk/AwsReadmeDecorator.kt b/aws/sdk-codegen/src/main/kotlin/software/amazon/smithy/rustsdk/AwsReadmeDecorator.kt index 91953af76..485b90b18 100644 --- a/aws/sdk-codegen/src/main/kotlin/software/amazon/smithy/rustsdk/AwsReadmeDecorator.kt +++ b/aws/sdk-codegen/src/main/kotlin/software/amazon/smithy/rustsdk/AwsReadmeDecorator.kt @@ -71,7 +71,7 @@ class AwsReadmeDecorator : RustCodegenDecorator { ## Using the SDK Until the SDK is released, we will be adding information about using the SDK to the - [Guide](https://github.com/awslabs/aws-sdk-rust/blob/main/Guide.md). Feel free to suggest + [Developer Guide](https://docs.aws.amazon.com/sdk-for-rust/latest/dg/welcome.html). Feel free to suggest additional sections for the guide by opening an issue and describing what you are trying to do. ## Getting Help -- GitLab