cc @mit-mit @sigurdm

https://github.com/grpc/grpc/blob/master/src/cpp/README.md#make
It looks like bazel has had a non-backwards compatible upgrade since this page was written - the http_archive rule needs to be imported/included.
I got it working by adding
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

Additionally and on a less technical front, it'd probably be worth explaining:

• that the example code needs to be in a WORKSPACE file
• how to choose a grpc version

At the moment, there are significant unnecessary barriers to grpc newbies: you/we are telling them to use bazel, which they may never have used before, but expecting them to know how to use bazel already. You/we are also assuming they know which commit hash they should be using.

https://grpc.io/docs/quickstart/cpp/ says "follow the instructions to install gRPC C++ via make", but the linked page leads with bazel (with a secondary reference to cmake).

Describe the bug
The following link in the C++ documentation is broken: https://grpc.github.io/grpc/cpp/classgrpc__impl_1_1_server_context_base.html

To Reproduce
Go to: https://grpc.github.io/grpc/cpp/classgrpc__impl_1_1_server_context_base.html
Recieve a 404.

Expected behavior
The ServerContextBase documentation loads.

Screenshots

Additional context
This is especially annoying as many methods in ServerContext are inherited from here and I can't access the documentation through your site.

Several API reference links direct to grpc.github.io, but that repo (https://github.com/grpc/grpc.github.io) has been archived.

To Reproduce
Steps to reproduce the behavior:

1. Visit https://grpc.io/docs/reference
2. Click on the C++ API reference.
3. A new tab will open over https://grpc.github.io/grpc/cpp/index.html

Maybe it would be preferable (as is done for the Go API), to link to an external site?

Here is an example from http://localhost:1313/docs/tutorials/basic/java/

There are two causes:

1. In some cases the list content isn't properly indented.
2. Even when properly indented, hugo v0.55.0 doesn't format such lists correctly. So to fix this issue completely will require a fix to #89 too.

The following blog entries (from 2016) aren't being published because they have published: false in their front matter:

• https://github.com/grpc/grpc.io/blob/master/content/blog/2016-07-25-vendasta.md
• https://github.com/grpc/grpc.io/blob/master/content/blog/2016-7-26-mobile-benchmarks.md

Why aren't the pages be published? Were they temporarily removed, or can they just be deleted?

@thisisnotapril WDYT?

... with contribution guidelines that reflect the actual process.

From @zacharysarah

Officially Supported Platforms in https://grpc.io/about/ missing

In some pages, the code-fence language used for protobuf code isn't protobuf as it should be.

• Android #110
• Dart #90
• Java #108

Here is an example from the Java Quickstart, where the java language tag is used instead of protobuf:

The code should instead be highlighted like this:

• Sending/receiving on client side
• sending/receiving on server side

python -m pip install grpc --no-cache-dir
Collecting grpc
Downloading https://files.pythonhosted.org/packages/dd/63/e25fa1e7dbbd44ae4d2d5ceb1bfef517849c854795e73d01bfd3d250a8b1/grpc-0.3-19.tar.gz
ERROR: Complete output from command python setup.py egg_info:
ERROR: Traceback (most recent call last):
File "", line 1, in
File "C:\Users\major\AppData\Local\Temp\pip-install-r9czerqi\grpc\setup.py", line 7, in
version_tuple = import('grpc').VERSION
File "C:\Users\major\AppData\Local\Temp\pip-install-r9czerqi\grpc\grpc_init_.py", line 6, in
from .rpc import *
File "C:\Users\major\AppData\Local\Temp\pip-install-r9czerqi\grpc\grpc\rpc.py", line 141
except OSError, ex:
^
SyntaxError: invalid syntax
----------------------------------------
ERROR: Command "python setup.py egg_info" failed with error code 1 in C:\Users\major\AppData\Local\Temp\pip-install-r9czerqi\grpc\

Example about how to have several gRPC services running on the same gRPC server with a code snippet.

I noticed you did some refactoring and now the Tutorials submenu doesn't work, meaning that when you go to a Tutorial you lose the submenu on the left. Can you fix please?

Hello,

How big should a single grpc service be? How many rpc's is "too many" in general or as a rough heuristic? What are the typical considerations when deciding what to lump together vs split? I apologize if this is the wrong place to ask these questions. Thank you.

Currently, I see two main sources of documentation for the grpc.io:

• There is this website, generated by hugo.
• There is the doc folder in the grpc repository: https://github.com/grpc/grpc/tree/master/doc

I think it would be a good idea to have a centralized place for the documentation so that contributors know where to contribute new content.

I would suggest to migrate it here as it will have a clean URL that will make it easier to find through a web search.

h5 has a smaller font than regular paragraph text. See here or here. Can it be made larger and more distinct?

Also, h2s are still smaller than h3s which is problematic on a page like this.

I noticed you added a "Quick Start Home" entry to the menu here. I don't think we need that as other menus like the tutorials don't have a "home" entry.

If you do want to keep it could you make it so that it is class="active" when you are on it?

The quick start and tutorial examples depend on the protoc_plugin v18, which, when guides were written, was the latest version.

Since then, v19 has been released, but this version introduces breaking changes and requires protobuf v1.x.

So either the guides need to be updated to:

• Constrain the version of protoc_plugin that is downloaded to be < 19, or
• Example pubspecs need to be updated to use protobuf v1.x.

Right now, the site's CSS is 100% bespoke. This makes it quite difficult to update the site's aesthetic and to ensure things like mobile friendliness in a consistent manner. The site should use a CSS framework with built-in responsiveness capabilities, off-the-shelf components, and the like.

I just realized that #87 goes away when using the latest Hugo version (0.65.x), probably because of the switch (since 0.59.x) to adhering to CommonMark markdown syntax.

Of course there is some risk in switching to the latest version if Hugo in that some pages might be rendered differently. But that is partly the point, in some cases, the difference is a fix in the interpretation of the markdown. The risk can be mitigated by diffing the generated sites.

@thisisnotapril WDYT?

From https://groups.google.com/d/msgid/grpc-io/a13d4456-fbb6-4b89-922f-69672804a07f%40googlegroups.com:

1. https://grpc.io/docs/quickstart/cpp/ says "follow the instructions to install gRPC C++ via make", but the linked page leads with bazel (with a secondary reference to cmake).
2. The linked page: https://github.com/grpc/grpc/blob/master/src/cpp/README.md#make doesn't work. I think it may be because http_archive has been moved/deprecated but the rules don't include the relevant spell to import it - see https://stackoverflow.com/questions/56229865/build-breaking-after-bazel-upgrade

@nicolasnoble writes:

We should direct people towards Bazel as much as possible for the quickstart, especially since the ./tools/bazel script should be fine for Linux and windows even if Bazel isn't installed.

cc @thisisnotapril

Let folks know where and how to contribute to the docs from the docs.

From @zacharysarah

Left submenu no longer highlights the current Tutorial.

This is a copy of an unfixed problem: grpc/grpc.github.io#803

https://grpc.io/blog/grpc-stacks mentions "For example, you could use C# instead, and use an In-Process transport", which doesn't seem to be accurate. While this is true in principle, C# actually doesn't expose the APIs to create in-proc channel (such as https://github.com/grpc/grpc/blob/618a3f561d4a93f263cca23abad086ed8f4d5e86/src/core/ext/transport/inproc/inproc_transport.h#L26), and therefore you can't currently use an inproc transport with C#.
We should update the blogpost and provide a better example.

This has been pointed out by https://groups.google.com/forum/#!msg/grpc-io/-H_Zjletyng/Q8xuwFluAgAJ.

Describe the bug
The link to CompletionQueue within the page helloasync-cpp/ is broken (404 HTTP response)

To Reproduce
Steps to reproduce the behavior:

1. Go to https://www.grpc.io/docs/tutorials/async/helloasync-cpp/
2. Click on CompletionQueue link under the Overview section

Expected behavior
Doc for CompletionQueue is opened

Desktop (please complete the following information):

• OS: Win10
• Browser: chrome

Consider making this a docsy site, and address the following issues:

• Support in-page TOCs for mobile and maybe desktop too #169
• Navigation sidebar cannot easily be scrolled #217
• Analytics and SEO improvements #362
  • Add breadcrumbs for at least the language pages - #233
  • Make page titles unique - #363

cc @thisisnotapril

Apologies If I made this query in the wrong place. I am curious to know whether you are accepting resources from external contributors to the grpc.io website.

The reason behind this query is, we(@kasun04 and @daneshk) wrote a new book on gRPC 'gRPC Up and Running' recently and we created samples in different languages around this book. You can find the source code in here.
I just want to check whether you consider adding these kinds of resources in your website under external resources.

If you do, we are happy to contribute. Looking forward to hearing from you.
Thanks in advance
Danesh

make serve does not currently work on master:

rbellevi@rbell:~/Dev/grpc.io$ make serve
hugo server \
        --buildDrafts \
        --buildFuture \
        --disableFastRender
Built in 192 ms
Error: Error building site: TOCSS: failed to transform "sass/style.sass" (text/x-sass): resource "sass/sass/style.sass_5538683f21764355e16f4f866a5e0357" not found in file cache
make: *** [Makefile:9: serve] Error 255
rbellevi@rbell:~/Dev/grpc.io$ hugo version
Hugo Static Site Generator v0.67.1-4F44227B linux/amd64 BuildDate: 2020-03-15T19:31:42Z

d721e7c appears to be the first bad commit:

git bisect start master 599c577dbd714eedcd3c83a52099adedc3380b98
git bisect run bash -c 'timeout -s INT 2 make serve; [ "$?" == "124" ]'

I'm also unable to test changes via make docker-serve, meaning we currently have no ability to test out changes to grpc.io.

CC @lucperkins
CC @chalin
CC @thisisnotapril

I cannot find a URL for an RSS or Atom feed to subscribe to for your blog. Please advise.

https://grpc.io/feed used to work but no longer does. Thank you.

• Add placeholder pages for the quick start and tutorial so that we can link to them from other sites before the final versions are published - #141
• About page supported languages and platforms
  • Add Kotlin entry - (#141), #142
  • Remove "under development" qualifier - 59e5173
• Create Kotlin quick start - (#141), #124, #194
• Create Kotlin basic tutorial (docs/tutorials/basic/kotlin.md) - (#141), #157, #194
• API reference:
  • Ensure API reference has been generated and is accessible; see grpc/grpc-kotlin#5.
  • Ensure that there is a link to the Kotlin API reference from the Reference page - #165, #175
• Add Kotlin entry to packages.grpc.io - grpc/grpc#22451
• Add Kotlin to grpc/grpc README - grpc/grpc#22450
• Merge kotlin branch into master

After launch:

• Blog post on grpc.io referring to the Google Cloud blog entry (here's the tweet) - #196
• Delete grpc-java/examples/example-kotlin - grpc/grpc-java#6936

Questions:

• Do we want to provide some guidance in terms of writing unit tests for grpc-kotlin apps (and write an example for the Hello World app)? Cf. grpc-java/examples/example-kotlin's Unit test examples

Answered:

• On which platforms (Windows, Linux, Mac) can grpc-kotlin be used?
• Router guide example:
  • Stick with proto Duration type, even if it isn't used in other examples?
  • Drop/cleanup Java specific option declarations?

I see the font size is different throughout the site. Is that intended? For example, here it is 16px but here it's 14.7px.

It would be a good idea to have a part of the website reserved for testimonies and case studies such as the one on Kubernetes: https://kubernetes.io/case-studies/

It could feature use-cases from:

• Netflix
• etcd
• Kubernetes
• Dropbox

With external links. At the moment, there is a "Used by" on the main page but not any link towards a use-case.

Consider adding an indicator when links are external to the site.

Here's an example from https://flutter.dev/docs:

Hi Team, dockerhub mentions this page https://www.grpc.io/docs/tutorials/basic/c.html but seems like it is broken , let me know if you need any help fixing that.

Thanks to @brendandburns who originally found this issue.

Hi there,
I am from PingCAP. Recently I just opened a PR #68 to add PingCAP use case to the gRPC website. But there seems to no furthering actions happening to this PR. Can someone review or let me know if I did this rightly? Thanks.

It would feature examples about how to use interceptors:

• server side / unary interceptor
• server side / streaming interceptor
• client side / unary interceptor
• client side / streaming interceptor

Here is an example from the Java Quickstart:

• Android #110
• Dart #90
• Java #108

https://grpc.io/docs/quickstart/cpp/ directs users to build protobufs by using make.
There are two problems with this:

1. protobufs are a submodule - I reckon not everyone knows how to clone a repo WITH the submodules
2. there's no Makefile - it looks like it's been moved over to bazel

Not all issues are bugs, so we should support more than the "bug" template, if only an "other" template.

Syntax error

See the other issue opened

pip3 install grpc --ignore-installed
Collecting grpc
Using cached https://files.pythonhosted.org/packages/dd/63/e25fa1e7dbbd44ae4d2d5ceb1bfef517849c854795e73d01bfd3d250a8b1/grpc-0.3-19.tar.gz
Complete output from command python setup.py egg_info:
Traceback (most recent call last):
File "", line 1, in
File "/tmp/pip-install-x8_v1sko/grpc/setup.py", line 7, in
version_tuple = import('grpc').VERSION
File "/tmp/pip-install-x8_v1sko/grpc/grpc/init.py", line 6, in
from .rpc import *
File "/tmp/pip-install-x8_v1sko/grpc/grpc/rpc.py", line 141
except OSError, ex:
^
SyntaxError: invalid syntax

----------------------------------------

Command "python setup.py egg_info" failed with error code 1 in /tmp/pip-install-x8_v1sko/grpc/

Describe the bug

Tutorial page links "C" to "C++" tutorial. Documentation > Tutorial > C links to C++ link.

To Reproduce

1. Go to https://grpc.io/docs/tutorials/basic/c/
2. Click "C" in the left menu.

Expected behavior

The link text should be "C++" instead of "C". The quickstart page is doing correctly.

Screenshots

What did you do?

As per https://github.com/grpc/grpc/blob/master/BUILDING.md#unix:

$ git clone -b $(curl -L https://grpc.io/release) https://github.com/grpc/grpc

What did you expect to see?

I expected curl -L https://grpc.io/release to return the version/branch, which could then be checked out.

What did you see instead?

curl -L https://grpc.io/release returns a 404.

Historically, gRPC.io has had a poor color contrast.. we should fix it once and for all with the re-vamp. Ideally, optimize the site for accessibility..

Issue originally from @hsaliak .

Describe the bug
The reference docs for the code generated by the GRPC Plugins are not linked anywhere from the GRPC site.

To Reproduce

1. Go to 'https://grpc.io/docs/reference/'
2. Click on 'Go API'
3. Reference docs are about the base API for establishing GRPC connections, not about code generated by GRPC plugins

Expected behavior
Two links - One to https://godoc.org/google.golang.org/grpc, another https://grpc.io/docs/reference/go/generated-code/

With a mention about gRPC Health Probe

It is currently documented as 2.0+.