Update documentation to include changes in aws jslib v0.9.0 #1276
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
|
There's a version of the docs published here: https://mdr-ci.staging.k6.io/docs/refs/pull/1276/merge It will be deleted automatically in 30 days. |
immavalls
approved these changes
Aug 4, 2023
There was a problem hiding this comment.
LGTM, lots of work to change all the examples 💪🏼. I tested most examples in the main pages (AwsConfig, S3Client, KMSClient, SecretsManagerClient, and SignatureV4), and they work very well.
Unrelated, are we still missing the Kinesis docs?
src/components/shared/blocking-aws-blockquote/blocking-aws-blockquote.view.js
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/20 jslib/01 jslib/01 aws/00 SQSClient.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/20 jslib/01 jslib/01 aws/00 SignatureV4.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/20 jslib/01 jslib/01 aws/SignatureV4/00 sign().md
Outdated
Show resolved
Hide resolved
heitortsergent
approved these changes
Aug 9, 2023
src/data/markdown/docs/05 Examples/01 Examples/02 http-authentication.md
Show resolved
Hide resolved
src/components/shared/blocking-aws-blockquote/blocking-aws-blockquote.view.js
Outdated
Show resolved
Hide resolved
src/components/shared/blocking-aws-blockquote/blocking-aws-blockquote.view.js
Outdated
Show resolved
Hide resolved
src/components/shared/blocking-aws-blockquote/blocking-aws-blockquote.view.js
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/20 jslib/01 jslib/01 aws/00 SecretsManagerClient.md
Outdated
Show resolved
Hide resolved
...0 jslib/01 jslib/01 aws/S3Client/00 abortMultipartUpload(bucketName, objectKey, uploadId).md
Show resolved
Hide resolved
…ckquote.view.js Co-authored-by: Heitor Tashiro Sergent <[email protected]>
Co-authored-by: Heitor Tashiro Sergent <[email protected]>
src/components/shared/blocking-aws-blockquote/blocking-aws-blockquote.view.js
Outdated
Show resolved
Hide resolved
…ckquote.view.js Co-authored-by: Heitor Tashiro Sergent <[email protected]>
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.
This Pull Request adapts the aws jslib documentation section to fit the changes introduced by version 0.9.0.
This big release makes almost all the APIs facing the user asynchronous and compatible with the
async/awaitsyntax. Previous releases exposing synchronous codes will stay out there, untouched. Still, as the documentation website is not versioned, only the documentation for the async version will be available once this PR is merged.This is a massive PR, I apologize for that, but I still look forward for you folks spotting all the tiny mistakes and "I forgot" occurrences probably scattered across the PR 🙇🏻