-
Notifications
You must be signed in to change notification settings - Fork 223
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
An experimental grpc module graduation #1472
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.
Honestly, I find a bit strange to see a Caution warning in blue. I would expect a yellow, orange or soft red. 😄
LGTM 🎉
@olegbespalov I don't know if it happens also to you, but for building locally, I had to rebase with the main
branch because npm start
with this branch gets a conflict regarding the browser then the command never finishes to build.
I belive it's because I opened this before the #1440 has been merged, but just in case I'll do re-base and push the changes 👍 |
d61ea34
to
dd843b8
Compare
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.
I left a few comments, mostly some minor nits. Overall, it looks good! 🙏
docs/sources/next/javascript-api/k6-net-grpc/stream/stream-on.md
Outdated
Show resolved
Hide resolved
docs/sources/next/javascript-api/k6-net-grpc/stream/stream-write.md
Outdated
Show resolved
Hide resolved
docs/sources/next/javascript-api/k6-experimental/grpc/_index.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
Hey @heitortsergent ! Thanks for receiving it! I see a lot of |
Yeah, we should do this across all files in the docs/sources folder. I've been meaning to do it but just haven't gotten around to it. 😓 |
Okay, then, in the scope of this PR, I'll adjust more files from |
What?
This pull requests "graduates" the docs for the experimental grpc module. It ports the streaming API parts to the
k6/net/grpc
and warns customers to avoid using an experimental grpc module. It would be better to check the changes by commits.FYI, I'm also going to open a request for changing the old version to port a warning message not to use the experimental anymore but would like to do that after the release
Checklist
Please fill in this template:
make docs
command locally and verified that the changes look good.Select one of these and delete the others:
If updating the documentation for the most recent release of k6:
docs/sources/next
folder of the documentation.docs/sources/v{most_recent_release}
folder of the documentation.If updating the documentation for the next release of k6:
docs/sources/next
folder of the documentation.Related PR(s)/Issue(s)
grafana/k6#3490