-
Notifications
You must be signed in to change notification settings - Fork 224
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
Conversation
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.
LGTM, reviewing without the preview requires more effort 😢 Do we have plans for it?
Summoning @heitortsergent and @jdbaldry regarding @codebien's question about plans to have a preview generated for PRs 👀 |
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 |
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 a few comments, mostly small nits or changes and caught a few broken links, but overall it looks good!
docs/sources/next/javascript-api/k6-experimental/redis/client/_index.md
Outdated
Show resolved
Hide resolved
docs/sources/next/javascript-api/k6-experimental/redis/client/_index.md
Outdated
Show resolved
Hide resolved
docs/sources/next/javascript-api/k6-experimental/redis/client/_index.md
Outdated
Show resolved
Hide resolved
docs/sources/next/javascript-api/k6-experimental/redis/client/_index.md
Outdated
Show resolved
Hide resolved
docs/sources/next/javascript-api/k6-experimental/redis/client/_index.md
Outdated
Show resolved
Hide resolved
docs/sources/next/javascript-api/k6-experimental/redis/redis-options.md
Outdated
Show resolved
Hide resolved
docs/sources/next/javascript-api/k6-experimental/redis/redis-options.md
Outdated
Show resolved
Hide resolved
docs/sources/next/javascript-api/k6-experimental/redis/redis-options.md
Outdated
Show resolved
Hide resolved
docs/sources/next/javascript-api/k6-experimental/redis/redis-options.md
Outdated
Show resolved
Hide resolved
docs/sources/next/javascript-api/k6-experimental/redis/redis-options.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Heitor Tashiro Sergent <[email protected]>
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'); |
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.
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?
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.
That's a fair point! We do illustrate using the password in the Client
documentation, though 👍🏻
Co-authored-by: Heitor Tashiro Sergent <[email protected]>
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 🤞🏻