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

An experimental grpc module graduation #1472

Merged
merged 4 commits into from
Jan 22, 2024

Conversation

olegbespalov
Copy link
Contributor

@olegbespalov olegbespalov commented Jan 11, 2024

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:

  • I have used a meaningful title for the PR.
  • I have described the changes I've made in the "What?" section above.
  • I have performed a self-review of my changes.
  • I have run the 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:

  • I have made my changes in the docs/sources/next folder of the documentation.
  • I have reflected my changes in the docs/sources/v{most_recent_release} folder of the documentation.
  • I have reflected my changes in the relevant (e.g. when correcting a documentation error) folders of the previous k6 versions of the documentation.

If updating the documentation for the next release of k6:

  • I have made my changes in the docs/sources/next folder of the documentation.

Related PR(s)/Issue(s)

grafana/k6#3490

@olegbespalov olegbespalov requested review from heitortsergent and a team January 11, 2024 10:33
@olegbespalov olegbespalov self-assigned this Jan 11, 2024
@olegbespalov olegbespalov requested review from mstoykov and codebien and removed request for a team January 11, 2024 10:33
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.

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.

@olegbespalov
Copy link
Contributor Author

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 👍

@olegbespalov olegbespalov force-pushed the feat/experimental-grpc-graduation branch from d61ea34 to dd843b8 Compare January 17, 2024 07:56
@olegbespalov olegbespalov mentioned this pull request Jan 17, 2024
8 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.

I left a few comments, mostly some minor nits. Overall, it looks good! 🙏

docs/sources/next/javascript-api/k6-net-grpc/_index.md Outdated Show resolved Hide resolved
docs/sources/next/javascript-api/k6-net-grpc/_index.md Outdated Show resolved Hide resolved
docs/sources/next/javascript-api/k6-net-grpc/_index.md Outdated Show resolved Hide resolved
docs/sources/next/using-k6/metrics/reference.md Outdated Show resolved Hide resolved
docs/sources/next/shared/experimental-grpc-module.md Outdated Show resolved Hide resolved
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
@olegbespalov
Copy link
Contributor Author

Hey @heitortsergent ! Thanks for receiving it! I see a lot of excerpt -> description changes. Should I do this across all files? Should we do this globally? 🤔

@heitortsergent
Copy link
Collaborator

Hey @heitortsergent ! Thanks for receiving it! I see a lot of excerpt -> description changes. Should I do this across all files? Should we do this globally? 🤔

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. 😓

@olegbespalov
Copy link
Contributor Author

Okay, then, in the scope of this PR, I'll adjust more files from k6/net/grpc 18f23af

@olegbespalov olegbespalov merged commit bcc1c6b into main Jan 22, 2024
6 checks passed
@olegbespalov olegbespalov deleted the feat/experimental-grpc-graduation branch January 22, 2024 07:06
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.

4 participants