Skip to content

feat: add grpc to glossary#3551

Open
Sonichigo wants to merge 10 commits intocncf:mainfrom
Sonichigo:add-grpc-term
Open

feat: add grpc to glossary#3551
Sonichigo wants to merge 10 commits intocncf:mainfrom
Sonichigo:add-grpc-term

Conversation

@Sonichigo
Copy link
Copy Markdown

@Sonichigo Sonichigo commented Aug 29, 2025

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.

  • Added content/en/grpc.md to 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 x in the checkboxes)

  • This PR does not contain plagiarism
    • don’t copy other people’s work unless you are quoting and contributing it to them.
  • I have signed off on all commits
    • signing off (ex: git commit -s) is to affirm that commits comply DCO. If you are working locally, you could add an alias to your gitconfig by running git config --global alias.ci "commit -s".

Signed-off-by: Animesh Pathak <53110238+Sonichigo@users.noreply.github.com>
@netlify
Copy link
Copy Markdown

netlify bot commented Aug 29, 2025

Deploy Preview for cncfglossary ready!

Name Link
🔨 Latest commit aa3c987
🔍 Latest deploy log https://app.netlify.com/projects/cncfglossary/deploys/6993175b551e6e00080f9692
😎 Deploy Preview https://deploy-preview-3551--cncfglossary.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@iamNoah1 iamNoah1 self-assigned this Aug 29, 2025
Copy link
Copy Markdown
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice idea to add gRPC.
Can someone from the gRPC team review this? @gnossen @ejona86 @thisisnotapril

See inline comments.

/cc @nate-double-u

Comment thread content/en/grpc.md Outdated
Comment thread content/en/grpc.md Outdated
Sonichigo and others added 2 commits September 25, 2025 17:23
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Signed-off-by: Animesh Pathak <53110238+Sonichigo@users.noreply.github.com>
Added a link to the gRPC website for reference.

Signed-off-by: Animesh Pathak <53110238+Sonichigo@users.noreply.github.com>
@Sonichigo
Copy link
Copy Markdown
Author

@chalin I have resolved the comments!

@gnossen @ejona86 @thisisnotapril can I get feedback/suggestion on this PR?

@Sonichigo
Copy link
Copy Markdown
Author

@iamNoah1 @nate-double-u can i get review?

Copy link
Copy Markdown
Collaborator

@iamNoah1 iamNoah1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Collaborator

@hlipsig hlipsig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Collaborator

@jihoon-seo jihoon-seo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The links are not working as-is.

Comment thread content/en/grpc.md Outdated
Comment thread content/en/grpc.md Outdated
Comment thread content/en/grpc.md Outdated
Sonichigo and others added 5 commits November 12, 2025 12:02
Co-authored-by: Jihoon Seo <46767780+jihoon-seo@users.noreply.github.com>
Signed-off-by: Animesh Pathak <53110238+Sonichigo@users.noreply.github.com>
Co-authored-by: Jihoon Seo <46767780+jihoon-seo@users.noreply.github.com>
Signed-off-by: Animesh Pathak <53110238+Sonichigo@users.noreply.github.com>
Co-authored-by: Jihoon Seo <46767780+jihoon-seo@users.noreply.github.com>
Signed-off-by: Animesh Pathak <53110238+Sonichigo@users.noreply.github.com>
Signed-off-by: Animesh Pathak <53110238+Sonichigo@users.noreply.github.com>
Signed-off-by: Animesh Pathak <53110238+Sonichigo@users.noreply.github.com>
@Sonichigo Sonichigo requested a review from iamNoah1 December 5, 2025 07:39
Comment thread content/en/grpc.md Outdated
@chalin
Copy link
Copy Markdown
Contributor

chalin commented Jan 23, 2026

@Sonichigo - can you address the comments?

@GoldenLion7
Copy link
Copy Markdown

@chalin may I give it a try?

@GoldenLion7
Copy link
Copy Markdown

Anyone or @chalin I want to help with documentation or if anything else open and u want me to work upon

@Sonichigo
Copy link
Copy Markdown
Author

Sonichigo commented Jan 28, 2026

@chalin may I give it a try?

Hi @GoldenLion7 I'm still working on this one. You can pickup issues relevant from here - https://github.com/cncf/glossary/issues?q=is%3Aissue%20state%3Aopen%20no%3Aassignee

Co-authored-by: Nate W <natew@cncf.io>
Signed-off-by: Animesh Pathak <53110238+Sonichigo@users.noreply.github.com>
@GoldenLion7
Copy link
Copy Markdown

@Sonichigo no worries, go ahead. Take your time :)

@iamNoah1 iamNoah1 removed their request for review January 29, 2026 13:33
Improves the gRPC concept page to align with documentation definition guidelines and semantic line-break conventions. Based on https://glossary.cncf.io/style-guide/ have fixed the whitespaces and proper line semantic breaks.

Signed-off-by: Animesh Pathak <53110238+Sonichigo@users.noreply.github.com>
@Sonichigo
Copy link
Copy Markdown
Author

@nate-double-u can you check the following PR. I have updated it based on the guidelines and suggestion based on earlier reviewer's left has previously been included.

Copy link
Copy Markdown
Member

@nate-double-u nate-double-u left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Sonichigo, thanks for the updates.

This is quite long for one of our definitions. Please take a look at some of our other work to get a sense of how long a definition should be.

This still doesn't follow our style guide:

  • For instance, the gRPC vs. Alternatives section doesn't show up in any of our other work and should be omitted here.
  • Things like contractions should be avoided, generally. You can also find a list of tags there (the tags in this definition don't quite match up).
  • In the Problem it addresses section, avoid mentioning the term that is being defined, this section helps folks understand what led to needing the thing.

@iamNoah1 iamNoah1 removed their assignment Mar 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lang/en for English

Projects

Status: 📋 Backlog

Development

Successfully merging this pull request may close these issues.

[New term] Add gRPC to Glossary

8 participants