Skip to content
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

Document new redis options #1416

Merged
merged 5 commits into from Nov 30, 2023
Merged

Document new redis options #1416

merged 5 commits into from Nov 30, 2023

Conversation

oleiade
Copy link
Member

@oleiade oleiade commented Nov 15, 2023

k6 version 0.48 will introduce a breaking change in the way the k6/experimental/redis Client class is constructed.

This Pull Request documents the new API and its usage.

This is my first PR on the new version of the documentation, so 🤞🏻

Copy link
Contributor

@codebien codebien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, reviewing without the preview requires more effort 😢 Do we have plans for it?

@oleiade
Copy link
Member Author

oleiade commented Nov 17, 2023

Summoning @heitortsergent and @jdbaldry regarding @codebien's question about plans to have a preview generated for PRs 👀

@jdbaldry
Copy link
Member

It's not currently prioritized for my quarter but I have https://github.com/grafana/technical-documentation/issues/847 to keep track of the want.

I would like to see it for sure.

In the mean time, a local preview is available by running make docs from the docs/ directory.

@olegbespalov olegbespalov mentioned this pull request Nov 23, 2023
48 tasks
Copy link
Collaborator

@heitortsergent heitortsergent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few comments, mostly small nits or changes and caught a few broken links, but overall it looks good!

Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
addrs: redis_addrs.split(',') || new Array('localhost:6379'), // in the form of 'host:port', separated by commas
password: redis_password,
});
const redisClient = new redis.Client('redis://localhost:6379');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This not only updates to the new API, but also removes using a password in the example.

Is this intentional? Do we still have examples with password?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a fair point! We do illustrate using the password in the Client documentation, though 👍🏻

Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
@oleiade oleiade merged commit ddcef79 into main Nov 30, 2023
6 checks passed
@oleiade oleiade deleted the amend/redis-tls branch November 30, 2023 09:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants