-
Notifications
You must be signed in to change notification settings - Fork 239
add KinesisClient documentation for k6-jslib-aws #1980
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Add comprehensive documentation for KinesisClient including all methods: - createStream, deleteStream, listStreams - putRecords, getRecords, listShards, getShardIterator - Include examples for stream management and record operations - Add KinesisClient to AWS services index
|
- Add skip directives to prevent CI from running AWS API calls - JavaScript examples require valid AWS credentials and resources - Follows same pattern as other AWS client documentation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we also add these for older versions of k6? 🤔
PS: Note this is kinda related to the open question I left in the other PR for jslib docs.
docs/sources/k6/next/javascript-api/jslib/aws/KinesisClient/listShards.md
Outdated
Show resolved
Hide resolved
docs/sources/k6/next/javascript-api/jslib/aws/KinesisClient/listStreams.md
Outdated
Show resolved
Hide resolved
…stShards.md Co-authored-by: Joan López de la Franca Beltran <[email protected]>
…stStreams.md Co-authored-by: Joan López de la Franca Beltran <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left some suggestions, mostly removing some unnecessary lines. 🤓 I think the main content looks good!
docs/sources/k6/next/javascript-api/jslib/aws/KinesisClient/_index.md
Outdated
Show resolved
Hide resolved
docs/sources/k6/next/javascript-api/jslib/aws/KinesisClient/_index.md
Outdated
Show resolved
Hide resolved
docs/sources/k6/next/javascript-api/jslib/aws/KinesisClient/_index.md
Outdated
Show resolved
Hide resolved
docs/sources/k6/next/javascript-api/jslib/aws/KinesisClient/_index.md
Outdated
Show resolved
Hide resolved
docs/sources/k6/next/javascript-api/jslib/aws/KinesisClient/_index.md
Outdated
Show resolved
Hide resolved
docs/sources/k6/next/javascript-api/jslib/aws/KinesisClient/listStreams.md
Outdated
Show resolved
Hide resolved
docs/sources/k6/next/javascript-api/jslib/aws/KinesisClient/listStreams.md
Outdated
Show resolved
Hide resolved
docs/sources/k6/next/javascript-api/jslib/aws/KinesisClient/putRecords.md
Outdated
Show resolved
Hide resolved
docs/sources/k6/next/javascript-api/jslib/aws/KinesisClient/putRecords.md
Outdated
Show resolved
Hide resolved
docs/sources/k6/next/javascript-api/jslib/aws/KinesisClient/putRecords.md
Outdated
Show resolved
Hide resolved
…ndex.md Co-authored-by: Heitor Tashiro Sergent <[email protected]>
…ndex.md Co-authored-by: Heitor Tashiro Sergent <[email protected]>
Co-authored-by: Heitor Tashiro Sergent <[email protected]>
@joanlopez I gave it a shot, but it feels more like a burden than anything else. If you don't mind, I would like for us to elaborate a more robust solution for jslibs documentation versioning in general first, and keep the PR as-is 🙇🏻 |
@oleiade if this applies to latest, I can port those changes over and commit directly here if you don't mind. |
@heitortsergent If you have the mental space for it, that would be very much appreciated 🙏🏻 🙇🏻 |
@oleiade I applied the changes to latest. |
What?
Add comprehensive documentation for KinesisClient including all methods:
Checklist
npm start
command locally and verified that the changes look good.docs/sources/k6/next
folder of the documentation.Related PR(s)/Issue(s)