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: awslabs/aws-sdk-rust#325 Signed-off-by: bin liu <[email protected]> * 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: awslabs/aws-sdk-rust#325 Signed-off-by: bin liu <[email protected]> * Add fixing Developer Guide link to CHANGELOG.next.toml Signed-off-by: bin liu <[email protected]> Co-authored-by: Russell Cohen <[email protected]>
smithy-lang · Mar 21, 2022 · 6227120 · 6227120
1 parent 75056c6
commit 6227120
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git 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
@@ -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
@@ -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