Conversation
Signed-off-by: Animesh Pathak <53110238+Sonichigo@users.noreply.github.com>
✅ 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 <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>
|
@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
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
There was a problem hiding this comment.
The links are not working as-is.
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 - can you address the comments? |
|
@chalin may I give it a try? |
|
Anyone or @chalin I want to help with documentation or if anything else open and u want me to work upon |
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>
|
@Sonichigo no worries, go ahead. Take your time :) |
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>
|
@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. |
nate-double-u
left a comment
There was a problem hiding this comment.
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.
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".