#95

#95

On http://www.grpc.io/contribute/ in the section "grpc (C based)" Java and Go are also listed.

http://www.grpc.io/docs/#quick-start is inconsistent with the recommended installation strategy for some languages.

Our current installation recommendation is to install.
libgrpc, libgrpc-dev, language level proto runtime, language level grpc runtime (ie pip install protobuf grpcio).
This does not provide us with the tools needed to generate RPC interfaces. For example, in python we will be missing
protoc, grpc_python_plugin. Both of which need to be compiled from sources of protobuf and grpc respectively.

For each wrapped language, we need to:
Run through the packaged install, see if we are missing steps that involve compiling from source.
Change documentation to reflect these steps.

Assigning to Lisa, but we need child bugs for each language.

#95

The mobile nav collapsible menu is not yet set up, so the nav is broken on mobile.

#95

http://www.grpc.io/docs/guides/concepts.html
This page has two sections as TBD. Need to fill them up. @jayantkolhe who is the right owner with lisa to do these?

Current client side examples for RouteGuide still use NettyChannelBuilder
See: http://www.grpc.io/docs/tutorials/basic/java.html for these references.

The examples have switched to use ManagedChannel/ManagerChannelBuilder per
grpc/grpc-java#1008

On the server side, we now use Providers since grpc/grpc-java#1005
The documentation needs to be similarly updated to drop references to NettyServerBuilder and instead ServerBuilder/Server

@carl-mastrangelo could you help @LisaFC with the review? Flagging this as a bug since our docs are now out of date and show the use of API that has been marked as not-stable and experimental.

#95

This site is based on the content of the release branch, but the installation instructions for the examples say to clone master and then run the installation. After the clone step, there should be a git checkout origin/release-0_11 step.

This approach is described in the Examples section as no longer recommended and, per @jboeuf, the snippets just add "noise" to the doc.

#95

Need to reset the style for other pages, but keep the small style just as a special case for the landing page where it's intentionally small. The problem is that the home page style is being applied too broadly.

https://godoc.org/google.golang.org/grpc

http://cocoadocs.org/docsets/gRPC/0.11.1/ to confirm with Jorge

The section describing errors at http://www.grpc.io/docs/guides/wire.html#errors appears incorrectly formatted.

Protocol points to https://github.com/grpc/grpc-common/blob/master/PROTOCOL-HTTP2.md
This was moved to https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md yesterday.

We need to update the link.

Problematic section below:

There are two parts to making our RouteGuide service do its job: - Implementing the service interface generated from our service definition: doing the actual "work" of our service. - Running a gRPC server to listen for requests from clients and dispatch them to the right service implementation.

Following steps in http://www.grpc.io/docs/tutorials/basic/go.html until we are asked to run codegen.sh
This script is not pulled in via any of the previous commands.
We need to remove references to it. /cc @iamqizhao

https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md

vs

https://github.com/grpc/grpc.github.io/blob/master/docs/guides/wire.md

In general we should decide how we want to maintain these. Happy to replicate changes

Structure of auth guide is getting increasingly confusing as we add more examples! Follow on from grpc/grpc#4243

In http://www.grpc.io/docs/#writing-a-server, I'm seeing underscores interpreted as italics. In other words, I see:

class GreeterServer < Helloworld::Greeter::Service
  # sayhello implements the SayHello rpc method.
  def sayhello(helloreq, _unusedcall)
    Helloworld::HelloReply.new(message: "Hello #{hello_req.name}")
  end

instead of

class GreeterServer < Helloworld::Greeter::Service
  # say_hello implements the SayHello rpc method.
  def say_hello(hello_req, _unused_call)
    Helloworld::HelloReply.new(message: "Hello #{hello_req.name}")
  end

Like in golang.org's Featured Articles Section, we need a Top level section on
"Latest Posts"
Which links to the last 2 posts and has a 2 line abstract.
This will showcase:

• Recent updates to the site.
• Easily make posts visible to new site owners.

We need this before we post the beta announcement on the site, so likely this week if possible.

Currently we're missing (as far as I can see):

• some C++ examples (I know there are some in the general API section but they should be comprehensive and in Examples as well, as that's where users are going to look for them)
• some Objective C examples (there are none)
• just using SSL/TLS example for PHP (it looks like it's in the auth with Google example but I don't know enough about PHP to pull it out separately)
• Scopeless credentials example for Java (if it exists)

Sometimes we have a need to deep link directly to specific FAQ items. This task is to add bookmarkable anchors to each question.

So we've done a bunch of work to distribute pre-built protoc and plugin. However, for the command ../gradlew build it requires building protobuf manually. That can be avoided with ../gradlew build -PskipCodegen=true, but that doesn't help demonstrate how to use protoc with Java. It basically leads to wasted effort by our users, as seen in grpc/grpc-java#981.

Add link to to https://godoc.org/google.golang.org/grpc . These are the reference docs for Go.

My suggestion would be to add an explicit installation link here: http://www.grpc.io/docs/#quick-start and have a table for instructions per language to install. (like we have for code pull). Obviously the new updated instructions per language and OS.

The link of .proto file is broken in Defining the service section.

People coming to proto for the first time probably expect methods to be able to receive multiple arguments and possibly even able to return multiple. We should have a small bit of info about how having a single message in each direction isn't truly limiting since you add "arguments" as fields of that message. That could also be part of a "best practices", since it allows you to add fields over time.

At the bottom of http://www.grpc.io/grpc/python/.

I think it should say "© Copyright 2015, The gRPC Authors.", but it's probably @LisaFC's and @mugurm's decision to make. It definitely shouldn't be individuals listed by name. It could be that we don't even want copyright notice on our documentation?

Need to create template and nav items to support publishing posts on the site.

We should add a few more:

Simple, yet rich integration with auth and encryption libraries.
Easy to use flow control mechanism Built-in message compression that can be switched off (Future) Enhanced support for load-balancing solution integrations. Useful stats collected, aggregated by library, ability to access and export them enables developer and operator tuning and monitoring

/cc @jayantkolhe

We are currently working on populating the performance dashboard (it is not ready yet), but just to get an idea, this is how approx. it is going to look like:
https://performance-dot-grpc-testing.appspot.com/explore?dashboard=5760820306771968

The Java Quickstart has not yet been moved over. We need to move it (and possibly update it) to fit in with the same style as the rest of the languages.

This work is part of the feature/docs branch and not yet on master. A PR is open.

docs/guides/auth.html needs a gRPC python example.

1. Code snippets not aligned with docs.
   Update RouteGuideServer Docs to reflect use of onValue()
   Doc:
   https://github.com/grpc/grpc.github.io/blob/master/docs/tutorials/basic/java.md
   Line 224
   Code:
   https://github.com/grpc/grpc-java/blob/master/examples/src/main/java/io/grpc/examples/routeguide/RouteGuideServer.java#L134

2. Broken link to example
   in https://github.com/grpc/grpc.github.io/blob/master/docs/tutorials/basic/java.md#L224

Currently, it points to:
https://github.com/grpc/grpc-java/master/examples/src/main/java/io/grpc/examples/RouteGuideServer.java
It needs to point to
https://github.com/grpc/grpc-java/blob/master/examples/src/main/java/io/grpc/examples/routeguide/RouteGuideServer.java

3. Update code snippets to align with example for the getFeatures method.
   Change getFeature(Point location) -> checkFeature(Point location)
   https://github.com/grpc/grpc.github.io/blob/master/docs/tutorials/basic/java.md#L169

https://github.com/grpc/grpc-java/blob/master/examples/src/main/java/io/grpc/examples/routeguide/RouteGuideServer.java#L261

http://www.grpc.io/docs/tutorials/basic/java.html references a http://www.grpc.io/docs/installation/java.html which does not exist.

grpc-java JavaDoc has been available for a little while at http://grpc.io/grpc-java/javadoc/. Now that links to the language documentation are being added, Java's should be added as well.

The text
"You can download and install Git from http://git-scm.com/download. Once installed you should have access to the git command line tool. The main commands that you will need to use are:
" in docs/index.html needs to link to http://git-scm.com/download rather than present it as plain text.

Tutorials say that proto3 is in alpha, which isn't the case for all languages. Can also provide links to language-specific proto3 reference and tutorials for some languages.

There is a reference to "http://www.grpc.io/docs/installation/php.html" which is a dead link in generating gRPC code of the getting started guide.