grpc / grpc.github.io Goto Github PK
View Code? Open in Web Editor NEWThe grpc.io website. (on GitHub pages)
The grpc.io website. (on GitHub pages)
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
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.
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.
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.
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:
We need this before we post the beta announcement on the site, so likely this week if possible.
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
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
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?
http://www.grpc.io/docs/tutorials/basic/java.html references a http://www.grpc.io/docs/installation/java.html which does not exist.
On http://www.grpc.io/contribute/ in the section "grpc (C based)" Java and Go are also listed.
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
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.
docs/guides/auth.html needs a gRPC python example.
The link of .proto
file is broken in Defining the service section.
The mobile nav collapsible menu is not yet set up, so the nav is broken on mobile.
Sometimes we have a need to deep link directly to specific FAQ items. This task is to add bookmarkable anchors to each question.
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.
Add link to to https://godoc.org/google.golang.org/grpc . These are the reference docs for Go.
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.
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.
https://godoc.org/google.golang.org/grpc
http://cocoadocs.org/docsets/gRPC/0.11.1/ to confirm with Jorge
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
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.
The section describing errors at http://www.grpc.io/docs/guides/wire.html#errors appears incorrectly formatted.
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.
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
This approach is described in the Examples section as no longer recommended and, per @jboeuf, the snippets just add "noise" to the doc.
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.
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.
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
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.
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.
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?
Structure of auth guide is getting increasingly confusing as we add more examples! Follow on from grpc/grpc#4243
Currently we're missing (as far as I can see):
Need to create template and nav items to support publishing posts on the site.
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.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.