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

Improve the WebSockets documentation once the experimental extension is considered stable #988

Open
immavalls opened this issue Jan 18, 2023 · 0 comments
Labels
Area: OSS Content Improvements or additions to community/oss documentation

Comments

@immavalls
Copy link
Contributor

Based on https://community.k6.io/t/max-number-of-websocket-connection/5663/13, I think we could document this a bit better for our users.

There is a good example in https://github.com/grafana/k6/releases/tag/v0.40.0, and it's worth documenting why built the extension. And what we recommend in terms of usage.

I myself missed this when going over the docs. I only saw the examples in https://k6.io/docs/using-k6/protocols/websockets/#load-testing-websockets-with-k6 and https://k6.io/docs/examples/websockets/ and missed https://k6.io/docs/javascript-api/k6-experimental/websockets/.

@MattDodsonEnglish MattDodsonEnglish added the Area: OSS Content Improvements or additions to community/oss documentation label Jan 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: OSS Content Improvements or additions to community/oss documentation
Projects
None yet
Development

No branches or pull requests

2 participants