Skip to content

Commit bbd8391

Browse files
committed
Integrate review comments
1 parent b8dd277 commit bbd8391

File tree

6 files changed

+10
-13
lines changed

6 files changed

+10
-13
lines changed

src/components/shared/blocking-aws-blockquote/blocking-aws-blockquote.view.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ const BlockingAwsBlockquote = () => (
66
mod="Attention"
77
title="Performance considerations and recommended practices"
88
>
9-
In some cases, such as downloading large files from S3, this could affect
10-
performance and test results. To minimize the impact on test performance, we
11-
recommend using these operations in the
9+
In some cases, using this javascript library's operations might impact
10+
performance and skew your test results. <br />
11+
<br />
12+
To ensure accurate results, consider executing these operations in the
1213
<span className="code-inline">setup</span> and{' '}
1314
<span className="code-inline">teardown</span>{' '}
1415
<a href="/docs/using-k6/test-lifecycle/">lifecycle functions</a>. These

src/data/markdown/docs/20 jslib/01 jslib/01 aws/00 SQSClient.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,11 @@ description: 'SQSClient enables interaction with the AWS Simple Queue Service (S
55
excerpt: 'SQSClient allows interacting with the AWS Simple Queue Service (SQS)'
66
---
77

8-
<BlockingAwsBlockquote />
9-
108
`SQSClient` interacts with the AWS Simple Queue Service (SQS).
119

12-
With it, the user can send messages to specified queues and list available queues in the current region. `SQSClient` operations are blocking.
10+
With it, the user can send messages to specified queues and list available queues in the current region.
1311

14-
Both the dedicated `sqs.js` jslib bundle and the all-encompassing `aws.js` bundle include the `SQSClient`.
12+
`SQSClient` is included in both the dedicated `sqs.js` jslib bundle and the all-encompassing `aws.js` one, containing all the services clients.
1513

1614
### Methods
1715

src/data/markdown/docs/20 jslib/01 jslib/01 aws/00 SecretsManagerClient.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ description: 'SecretsManagerClient allows interacting with AWS secrets stored in
55
excerpt: 'SecretsManagerClient allows interacting with AWS secrets stored in Secrets Manager'
66
---
77

8-
<BlockingAwsBlockquote />
9-
108
`SecretsManagerClient` interacts with the AWS Secrets Manager.
119

1210
With it, the user can list secrets owned by the authenticated user, download secrets, create new secrets, update secrets, and delete secrets.

src/data/markdown/docs/20 jslib/01 jslib/01 aws/00 SignatureV4.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: 'SignatureV4 is used to sign or pre-sign requests to AWS services u
55
excerpt: 'SignatureV4 is used to sign and pre-sign requests to AWS services using the Signature V4 algorithm'
66
---
77

8+
<BlockingAwsBlockquote />
9+
810
With SignatureV4, you can produce authenticated HTTP requests to AWS services. Namely, it lets you sign and pre-sign requests to AWS services using the [Signature V4](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) algorithm. The `sign` operation produces a signed request with authorization information stored in its headers.
911
The `presign` operation produces a pre-signed request with authorization information stored in its query string parameters.
1012

@@ -42,7 +44,7 @@ SignatureV4 methods throw errors on failure.
4244
<CodeGroup labels={[]}>
4345

4446
```javascript
45-
import http from 'k6/http.js'
47+
import http from 'k6/http'
4648

4749
import { AWSConfig, SignatureV4 } from 'https://jslib.k6.io/aws/0.9.0/aws.js'
4850

src/data/markdown/docs/20 jslib/01 jslib/01 aws/00 SystemsManagerClient.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ description: 'SystemsManagerClient allows interacting with the AWS Systems Manag
55
excerpt: 'SystemsManagerClient allows interacting with the AWS Systems Manager Service'
66
---
77

8-
<BlockingAwsBlockquote />
9-
108
`SystemsManagerClient` interacts with the AWS Systems Manager Service.
119

1210
With it, the user can get parameters from the Systems Manager Service in the caller's AWS account and region.

src/data/markdown/docs/20 jslib/01 jslib/01 aws/SignatureV4/00 sign().md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ You can override SignatureV4 options in the context of this specific request. To
4545
<CodeGroup labels={[]}>
4646

4747
```javascript
48-
import http from 'k6/http.js'
48+
import http from 'k6/http'
4949

5050
import { AWSConfig, SignatureV4 } from 'https://jslib.k6.io/aws/0.9.0/signature.js'
5151

0 commit comments

Comments
 (0)