feat: add grpc to glossary #3551
Conversation
Signed-off-by: Animesh Pathak <[email protected]>
Sonichigo
requested review from
Okabe-Junya,
caniszczyk,
hlipsig,
iamNoah1,
jihoon-seo,
nate-double-u and
seokho-son
as code owners
github-project-automation
bot
moved this to 📋 Backlog
in CNCF glossary definition review board
✅ Deploy Preview for cncfglossary ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Nice idea to add gRPC.
Can someone from the gRPC team review this? @gnossen @ejona86 @thisisnotapril
See inline comments.
/cc @nate-double-u
Co-authored-by: Patrice Chalin <[email protected]> Signed-off-by: Animesh Pathak <[email protected]>
Added a link to the gRPC website for reference. Signed-off-by: Animesh Pathak <[email protected]>
|
@chalin I have resolved the comments! @gnossen @ejona86 @thisisnotapril can I get feedback/suggestion on this PR? |
|
@iamNoah1 @nate-double-u can i get review? |
iamNoah1
left a comment
iamNoah1
left a comment
There was a problem hiding this comment.
@Sonichigo Thanks a lot for tackling this term and the effort you put in it. While it might be technically accurate I find it very complex to read. It references a lot of other technical terms, making it hard to understand for someone who is maybe not so much a technical person. Even if, it is not easy.
My encouragement is to double check on our styleguide: https://glossary.cncf.io/style-guide/ to understand how we want terms to be described ideally.
Please also pay attention to use semantic line breaks.
There was a problem hiding this comment.
Agreed with the previous review. Fantastic idea to include gPRC and an excellent effort. However, I also agree it's diffficult to understand without more of an anchor. I suspect this article could benefit from a comparison to help readers understand the why of gRPC. For example what the alternatives are and a more concise example of a use case in the "How it helps" section.
jihoon-seo
left a comment
jihoon-seo
left a comment
There was a problem hiding this comment.
The links are not working as-is.
Co-authored-by: Jihoon Seo <[email protected]> Signed-off-by: Animesh Pathak <[email protected]>
Co-authored-by: Jihoon Seo <[email protected]> Signed-off-by: Animesh Pathak <[email protected]>
Co-authored-by: Jihoon Seo <[email protected]> Signed-off-by: Animesh Pathak <[email protected]>
Signed-off-by: Animesh Pathak <[email protected]>
Signed-off-by: Animesh Pathak <[email protected]>
| Unlike traditional approaches like REST APIs that use text-based messages, gRPC uses a compact binary format, making communication faster and more efficient. | ||
| It uses HTTP/2 for transport, Protocol Buffers (protobuf) for interface definition and serialization, and provides features such as bi-directional streaming, flow control, header compression, and multiplexing. | ||
|
|
||
| ## Problem it solves |
There was a problem hiding this comment.
Thanks for this @Sonichigo, A note; this article breaks our style format somewhat, for instance:
| ## Problem it solves | |
| ## Problem it addresses |
and the following section gRPC vs. Alternatives.
The content is quite interesting, though. Please take a look at our Style Guide for your next set of edits.
7 participants
Describe your changes
This pull request adds a new conceptual documentation page for gRPC, covering its purpose, benefits, and use cases in modern distributed systems and microservices architectures.
content/en/grpc.mdto provide an overview of gRPC, including its architecture (HTTP/2, Protocol Buffers), the problems it solves in distributed systems, and its advantages for microservices, streaming, and interoperability.Related issue number or link (ex:
resolves #issue-number)resolves #1038
Checklist before opening this PR (put
xin the checkboxes)git commit -s) is to affirm that commits comply DCO. If you are working locally, you could add an alias to yourgitconfigby runninggit config --global alias.ci "commit -s".