From 4c4933e056cb2c1889c51242fa8317ea268083df Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Tue, 16 Jun 2020 08:40:59 -0400 Subject: [PATCH] Docs: fix links to quick start pages --- doc/python/sphinx/grpc.rst | 2 +- examples/cpp/README.md | 2 +- examples/cpp/helloworld/README.md | 2 +- examples/python/README.md | 2 +- examples/python/helloworld/README.md | 2 +- src/php/README.md | 32 ++++++++++++++-------------- src/ruby/README.md | 2 +- 7 files changed, 22 insertions(+), 22 deletions(-) diff --git a/doc/python/sphinx/grpc.rst b/doc/python/sphinx/grpc.rst index 67867a683e9..665392f28d0 100644 --- a/doc/python/sphinx/grpc.rst +++ b/doc/python/sphinx/grpc.rst @@ -6,7 +6,7 @@ gRPC Tutorial -------- -If you want to see gRPC in action first, visit the `Python Quickstart `_. +If you want to see gRPC in action first, visit the `Python Quickstart `_. Or, if you would like dive in with more extensive usage of gRPC Python, check `gRPC Basics - Python `_ out. diff --git a/examples/cpp/README.md b/examples/cpp/README.md index a0ff629b1a0..5254b30c832 100644 --- a/examples/cpp/README.md +++ b/examples/cpp/README.md @@ -9,5 +9,5 @@ README files. [gRPC Basics]: https://grpc.io/docs/tutorials/basic/cpp [Hello World]: helloworld -[Quick Start]: https://grpc.io/docs/quickstart/cpp +[Quick Start]: https://grpc.io/docs/languages/cpp/quickstart [Route Guide]: route_guide diff --git a/examples/cpp/helloworld/README.md b/examples/cpp/helloworld/README.md index e13c83281a7..a06cc8e3cb2 100644 --- a/examples/cpp/helloworld/README.md +++ b/examples/cpp/helloworld/README.md @@ -3,4 +3,4 @@ You can find a complete set of instructions for building gRPC and running the Hello World app in the [C++ Quick Start][]. -[C++ Quick Start]: https://grpc.io/docs/quickstart/cpp +[C++ Quick Start]: https://grpc.io/docs/languages/cpp/quickstart diff --git a/examples/python/README.md b/examples/python/README.md index 63d61e439b6..be57d89785d 100644 --- a/examples/python/README.md +++ b/examples/python/README.md @@ -1 +1 @@ -[This code's documentation lives on the grpc.io site.](https://grpc.io/docs/quickstart/python.html) +[This code's documentation lives on the grpc.io site.](https://grpc.io/docs/languages/python/quickstart) diff --git a/examples/python/helloworld/README.md b/examples/python/helloworld/README.md index 63d61e439b6..be57d89785d 100644 --- a/examples/python/helloworld/README.md +++ b/examples/python/helloworld/README.md @@ -1 +1 @@ -[This code's documentation lives on the grpc.io site.](https://grpc.io/docs/quickstart/python.html) +[This code's documentation lives on the grpc.io site.](https://grpc.io/docs/languages/python/quickstart) diff --git a/src/php/README.md b/src/php/README.md index 9aa66896684..e3723cd2faf 100644 --- a/src/php/README.md +++ b/src/php/README.md @@ -3,7 +3,7 @@ This directory contains source code for PHP implementation of gRPC layered on shared C library. The same installation guides with more examples and -tutorials can be seen at [grpc.io](https://grpc.io/docs/quickstart/php.html). +tutorials can be seen at [grpc.io](https://grpc.io/docs/languages/php/quickstart). gRPC PHP installation instructions for Google Cloud Platform is in [cloud.google.com](https://cloud.google.com/php/grpc). @@ -36,7 +36,7 @@ or specific version $ [sudo] pecl install grpc-1.25.0 ``` -Note: for users on CentOS/RHEL 6, unfortunately this step won’t work. +Note: for users on CentOS/RHEL 6, unfortunately this step won’t work. Please follow the instructions below to compile the PECL extension from source. @@ -74,8 +74,8 @@ $ make $ [sudo] make install ``` -This will compile and install the `grpc` extension into the -standard PHP extension directory. You should be able to run +This will compile and install the `grpc` extension into the +standard PHP extension directory. You should be able to run the [unit tests](#unit-tests), with the `grpc` extension installed. @@ -100,7 +100,7 @@ composer package as well. Add this to your project's `composer.json` file. } ``` -To run tests with generated stub code from `.proto` files, you will also +To run tests with generated stub code from `.proto` files, you will also need the `composer` and `protoc` binaries. You can find out how to get these below. @@ -120,7 +120,7 @@ classes. If you don't have it already, you need to install the protobuf compiler `protoc`, version 3.5.0+ (the newer the better) for the current gRPC version. -If you installed already, make the protobuf version is compatible to the +If you installed already, make the protobuf version is compatible to the grpc version you installed. If you build grpc.so from the souce, you can check the version of grpc inside package.xml file. @@ -128,15 +128,15 @@ The compatibility between the grpc and protobuf version is listed as table below: grpc | protobuf ---- | --- +--- | --- v1.0.0 | 3.0.0(GA) v1.0.1 | 3.0.2 -v1.1.0 | 3.1.0 -v1.2.0 | 3.2.0 -v1.2.0 | 3.2.0 -v1.3.4 | 3.3.0 +v1.1.0 | 3.1.0 +v1.2.0 | 3.2.0 +v1.2.0 | 3.2.0 +v1.3.4 | 3.3.0 v1.3.5 | 3.2.0 -v1.4.0 | 3.3.0 +v1.4.0 | 3.3.0 v1.6.0 | 3.4.0 v1.8.0 | 3.5.0 v1.12.0 | 3.5.2 @@ -197,7 +197,7 @@ version you build this plugin. ### `protobuf` runtime library There are two `protobuf` runtime libraries to choose from. They are identical -in terms of APIs offered. The C implementation provides better performance, +in terms of APIs offered. The C implementation provides better performance, while the native implementation is easier to install. #### C implementation (for better performance) @@ -365,11 +365,11 @@ $client = new Helloworld\GreeterClient('localhost:50051', [ ]); ``` -### Compression +### Compression You can customize the compression behavior on the client side, by specifying the following options when constructing your PHP client. -``` +``` Possible values for grpc.default_compression_algorithm: 0 - No compression 1 - Compress with DEFLATE algorithm @@ -387,7 +387,7 @@ Here's an example on how you can put them all together: ``` $client = new Helloworld\GreeterClient('localhost:50051', [ 'credentials' => Grpc\ChannelCredentials::createInsecure(), - 'grpc.default_compression_algorithm' => 2, + 'grpc.default_compression_algorithm' => 2, 'grpc.default_compression_level' => 2, ]); diff --git a/src/ruby/README.md b/src/ruby/README.md index f6fce3ed22e..8187d7f3b5c 100644 --- a/src/ruby/README.md +++ b/src/ruby/README.md @@ -74,5 +74,5 @@ Directory structure is the layout for [ruby extensions][] [ruby extensions]:http://guides.rubygems.org/gems-with-extensions/ [rubydoc]: http://www.rubydoc.info/gems/grpc -[grpc.io]: https://grpc.io/docs/quickstart/ruby.html +[grpc.io]: https://grpc.io/docs/languages/ruby/quickstart [Debian jessie-backports]:http://backports.debian.org/Instructions/