From 5ac3aa789f28c50419cdbf06981cb429998be9c9 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Tue, 16 Jun 2020 08:47:24 -0400 Subject: [PATCH] Docs: fix links to grpc.io tutorial pages --- doc/python/sphinx/grpc.rst | 2 +- examples/cpp/README.md | 2 +- examples/cpp/route_guide/README.md | 2 +- examples/csharp/Helloworld/README.md | 2 +- examples/csharp/HelloworldLegacyCsproj/README.md | 4 ++-- examples/csharp/RouteGuide/README.md | 2 +- examples/node/README.md | 2 +- examples/node/dynamic_codegen/route_guide/README.md | 2 +- examples/node/static_codegen/route_guide/README.md | 2 +- examples/objective-c/auth_sample/README.md | 2 +- examples/objective-c/helloworld/README.md | 2 +- examples/objective-c/route_guide/README.md | 2 +- examples/php/README.md | 2 +- examples/php/route_guide/README.md | 2 +- examples/python/metadata/README.md | 2 +- examples/python/multiplex/README.md | 2 +- examples/python/route_guide/README.md | 2 +- examples/ruby/README.md | 2 +- examples/ruby/route_guide/README.md | 2 +- src/cpp/README.md | 4 ++-- src/csharp/README.md | 12 ++++++------ 21 files changed, 28 insertions(+), 28 deletions(-) diff --git a/doc/python/sphinx/grpc.rst b/doc/python/sphinx/grpc.rst index 665392f28d0..4717eb12332 100644 --- a/doc/python/sphinx/grpc.rst +++ b/doc/python/sphinx/grpc.rst @@ -7,7 +7,7 @@ Tutorial -------- 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. +Or, if you would like dive in with more extensive usage of gRPC Python, check `gRPC Basics - Python `_ out. Example diff --git a/examples/cpp/README.md b/examples/cpp/README.md index 5254b30c832..7c281de30c0 100644 --- a/examples/cpp/README.md +++ b/examples/cpp/README.md @@ -7,7 +7,7 @@ For information about the other examples in this directory, see their respective README files. -[gRPC Basics]: https://grpc.io/docs/tutorials/basic/cpp +[gRPC Basics]: https://grpc.io/docs/languages/cpp/basics [Hello World]: helloworld [Quick Start]: https://grpc.io/docs/languages/cpp/quickstart [Route Guide]: route_guide diff --git a/examples/cpp/route_guide/README.md b/examples/cpp/route_guide/README.md index 1d1956d275d..2b2376ca180 100644 --- a/examples/cpp/route_guide/README.md +++ b/examples/cpp/route_guide/README.md @@ -3,4 +3,4 @@ The files in this folder are the samples used in [gRPC Basics: C++][], a detailed tutorial for using gRPC in C++. -[gRPC Basics: C++]:https://grpc.io/docs/tutorials/basic/cpp +[gRPC Basics: C++]:https://grpc.io/docs/languages/cpp/basics diff --git a/examples/csharp/Helloworld/README.md b/examples/csharp/Helloworld/README.md index e4771ee91a1..8897d4fc00c 100644 --- a/examples/csharp/Helloworld/README.md +++ b/examples/csharp/Helloworld/README.md @@ -36,4 +36,4 @@ Tutorial You can find a more detailed tutorial about Grpc in [gRPC Basics: C#][] [helloworld.proto]:../../protos/helloworld.proto -[gRPC Basics: C#]:https://grpc.io/docs/tutorials/basic/csharp.html +[gRPC Basics: C#]:https://grpc.io/docs/languages/csharp/basics diff --git a/examples/csharp/HelloworldLegacyCsproj/README.md b/examples/csharp/HelloworldLegacyCsproj/README.md index 4435faeb086..3f3889fe216 100644 --- a/examples/csharp/HelloworldLegacyCsproj/README.md +++ b/examples/csharp/HelloworldLegacyCsproj/README.md @@ -40,7 +40,7 @@ download all of the NuGet dependencies of gRPC. Using these IDEs, a workaround is as follows: * Obtain a nuget executable for your platform and update it with - `nuget update -self`. + `nuget update -self`. * Navigate to this directory and run `nuget restore`. * Now that packages have been restored into their proper package folder, build the solution from your IDE. @@ -71,4 +71,4 @@ Tutorial You can find a more detailed tutorial in [gRPC Basics: C#][] [helloworld.proto]:../../protos/helloworld.proto -[gRPC Basics: C#]:https://grpc.io/docs/tutorials/basic/csharp.html +[gRPC Basics: C#]:https://grpc.io/docs/languages/csharp/basics diff --git a/examples/csharp/RouteGuide/README.md b/examples/csharp/RouteGuide/README.md index 3cfb14ae9a9..bfdb9e14f06 100644 --- a/examples/csharp/RouteGuide/README.md +++ b/examples/csharp/RouteGuide/README.md @@ -3,4 +3,4 @@ The files in this folder are the samples used in [gRPC Basics: C#][], a detailed tutorial for using gRPC in C#. -[gRPC Basics: C#]:https://grpc.io/docs/tutorials/basic/csharp.html +[gRPC Basics: C#]:https://grpc.io/docs/languages/csharp/basics diff --git a/examples/node/README.md b/examples/node/README.md index 0264e9d66b7..b45488b8b56 100644 --- a/examples/node/README.md +++ b/examples/node/README.md @@ -47,4 +47,4 @@ TUTORIAL You can find a more detailed tutorial in [gRPC Basics: Node.js][] [Install gRPC Node]:../../src/node -[gRPC Basics: Node.js]:https://grpc.io/docs/tutorials/basic/node.html +[gRPC Basics: Node.js]:https://grpc.io/docs/languages/node/basics diff --git a/examples/node/dynamic_codegen/route_guide/README.md b/examples/node/dynamic_codegen/route_guide/README.md index 7d6b0b7debe..fcd147054a6 100644 --- a/examples/node/dynamic_codegen/route_guide/README.md +++ b/examples/node/dynamic_codegen/route_guide/README.md @@ -2,4 +2,4 @@ The files in this folder are the samples used in [gRPC Basics: Node.js][], a detailed tutorial for using gRPC in Node.js. -[gRPC Basics: Node.js]:https://grpc.io/docs/tutorials/basic/node.html +[gRPC Basics: Node.js]:https://grpc.io/docs/languages/node/basics diff --git a/examples/node/static_codegen/route_guide/README.md b/examples/node/static_codegen/route_guide/README.md index 7d6b0b7debe..fcd147054a6 100644 --- a/examples/node/static_codegen/route_guide/README.md +++ b/examples/node/static_codegen/route_guide/README.md @@ -2,4 +2,4 @@ The files in this folder are the samples used in [gRPC Basics: Node.js][], a detailed tutorial for using gRPC in Node.js. -[gRPC Basics: Node.js]:https://grpc.io/docs/tutorials/basic/node.html +[gRPC Basics: Node.js]:https://grpc.io/docs/languages/node/basics diff --git a/examples/objective-c/auth_sample/README.md b/examples/objective-c/auth_sample/README.md index a0063de3f2f..6e90be39b16 100644 --- a/examples/objective-c/auth_sample/README.md +++ b/examples/objective-c/auth_sample/README.md @@ -1,3 +1,3 @@ # OAuth2 on gRPC: Objective-C -This is the supporting code for the tutorial "[OAuth2 on gRPC: Objective-C](https://grpc.io/docs/tutorials/auth/oauth2-objective-c.html)." +This is the supporting code for the tutorial "[OAuth2 on gRPC: Objective-C](https://grpc.io/docs/languages/objective-c/oauth2)." diff --git a/examples/objective-c/helloworld/README.md b/examples/objective-c/helloworld/README.md index c57e07ca931..2bb6d6c7b6d 100644 --- a/examples/objective-c/helloworld/README.md +++ b/examples/objective-c/helloworld/README.md @@ -104,4 +104,4 @@ $ bazel run :HelloWorld --ios_simulator_version='' --ios_sumlator_devic ## Tutorial -You can find a more detailed tutorial in [gRPC Basics: Objective-C](https://grpc.io/docs/tutorials/basic/objective-c.html). +You can find a more detailed tutorial in [gRPC Basics: Objective-C](https://grpc.io/docs/languages/objective/basics-c.html). diff --git a/examples/objective-c/route_guide/README.md b/examples/objective-c/route_guide/README.md index 60e5304651a..d32f1699cb9 100644 --- a/examples/objective-c/route_guide/README.md +++ b/examples/objective-c/route_guide/README.md @@ -1,4 +1,4 @@ # gRPC Basics: Objective-C -This is the supporting code for the tutorial "[gRPC Basics: Objective-C](https://grpc.io/docs/tutorials/basic/objective-c.html)." +This is the supporting code for the tutorial "[gRPC Basics: Objective-C](https://grpc.io/docs/languages/objective/basics-c.html)." diff --git a/examples/php/README.md b/examples/php/README.md index 75b9e6fb829..2182e39628a 100644 --- a/examples/php/README.md +++ b/examples/php/README.md @@ -53,4 +53,4 @@ This requires `php` >= 5.5, `pecl`, `composer` You can find a more detailed tutorial in [gRPC Basics: PHP][] [Node]:https://github.com/grpc/grpc/tree/master/examples/node -[gRPC Basics: PHP]:https://grpc.io/docs/tutorials/basic/php.html +[gRPC Basics: PHP]:https://grpc.io/docs/languages/php/basics diff --git a/examples/php/route_guide/README.md b/examples/php/route_guide/README.md index 6bea70dea03..e5abfbba053 100644 --- a/examples/php/route_guide/README.md +++ b/examples/php/route_guide/README.md @@ -3,4 +3,4 @@ The files in this folder are the samples used in [gRPC Basics: PHP][], a detailed tutorial for using gRPC in PHP. -[gRPC Basics: PHP]:https://grpc.io/docs/tutorials/basic/php.html +[gRPC Basics: PHP]:https://grpc.io/docs/languages/php/basics diff --git a/examples/python/metadata/README.md b/examples/python/metadata/README.md index 5aa75d504a8..26ffa44f6fa 100644 --- a/examples/python/metadata/README.md +++ b/examples/python/metadata/README.md @@ -2,5 +2,5 @@ An example showing how to add custom HTTP2 headers (or [metadata](https://grpc.i HTTP2 supports initial headers and trailing headers, which gRPC utilizes both of them ([learn more](https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md)). -More complete documentation lives at [grpc.io](https://grpc.io/docs/tutorials/basic/python.html). +More complete documentation lives at [grpc.io](https://grpc.io/docs/languages/python/basics). For API reference please see [API](https://grpc.io/grpc/python/grpc.html). diff --git a/examples/python/multiplex/README.md b/examples/python/multiplex/README.md index 2316cd39e88..8afdb4dffeb 100644 --- a/examples/python/multiplex/README.md +++ b/examples/python/multiplex/README.md @@ -1,3 +1,3 @@ An example showing two stubs sharing a channel and two servicers sharing a server. -More complete documentation lives at [grpc.io](https://grpc.io/docs/tutorials/basic/python.html). +More complete documentation lives at [grpc.io](https://grpc.io/docs/languages/python/basics). diff --git a/examples/python/route_guide/README.md b/examples/python/route_guide/README.md index 890e66ebad0..6f7a2f0fdf0 100644 --- a/examples/python/route_guide/README.md +++ b/examples/python/route_guide/README.md @@ -1 +1 @@ -[This code's documentation lives on the grpc.io site.](https://grpc.io/docs/tutorials/basic/python.html) +[This code's documentation lives on the grpc.io site.](https://grpc.io/docs/languages/python/basics) diff --git a/examples/ruby/README.md b/examples/ruby/README.md index c6af1a5a5e8..2a3dec338fe 100644 --- a/examples/ruby/README.md +++ b/examples/ruby/README.md @@ -60,4 +60,4 @@ You can find a more detailed tutorial in [gRPC Basics: Ruby][] [helloworld.proto]:../protos/helloworld.proto [RVM]:https://www.rvm.io/ [Install gRPC ruby]:../../src/ruby#installation -[gRPC Basics: Ruby]:https://grpc.io/docs/tutorials/basic/ruby.html +[gRPC Basics: Ruby]:https://grpc.io/docs/languages/ruby/basics diff --git a/examples/ruby/route_guide/README.md b/examples/ruby/route_guide/README.md index 12537c859e1..83501d4babf 100644 --- a/examples/ruby/route_guide/README.md +++ b/examples/ruby/route_guide/README.md @@ -3,4 +3,4 @@ The files in this folder are the samples used in [gRPC Basics: Ruby][], a detailed tutorial for using gRPC in Ruby. -[gRPC Basics: Ruby]:https://grpc.io/docs/tutorials/basic/ruby.html +[gRPC Basics: Ruby]:https://grpc.io/docs/languages/ruby/basics diff --git a/src/cpp/README.md b/src/cpp/README.md index 4f2dbc6014b..967a0a43b7f 100755 --- a/src/cpp/README.md +++ b/src/cpp/README.md @@ -167,10 +167,10 @@ documentation site at [grpc.io](https://grpc.io), specifically: * [Overview](https://grpc.io/docs): An introduction to gRPC with a simple Hello World example in all our supported languages, including C++. -* [gRPC Basics - C++](https://grpc.io/docs/tutorials/basic/cpp): +* [gRPC Basics - C++](https://grpc.io/docs/languages/cpp/basics): A tutorial that steps you through creating a simple gRPC C++ example application. -* [Asynchronous Basics - C++](https://grpc.io/docs/tutorials/async/helloasync-cpp): +* [Asynchronous Basics - C++](https://grpc.io/docs/languages/cpp/async): A tutorial that shows you how to use gRPC C++'s asynchronous/non-blocking APIs. diff --git a/src/csharp/README.md b/src/csharp/README.md index 089588254fd..f45d6e33706 100644 --- a/src/csharp/README.md +++ b/src/csharp/README.md @@ -18,7 +18,7 @@ The following documentation is for the original gRPC C# implementation only (the SUPPORTED PLATFORMS ------------------ -- [.NET Core](https://dotnet.github.io/) on Linux, Windows and Mac OS X +- [.NET Core](https://dotnet.github.io/) on Linux, Windows and Mac OS X - .NET Framework 4.5+ (Windows) - Mono 4+ on Linux, Windows and Mac OS X @@ -39,7 +39,7 @@ HOW TO USE - Open Visual Studio and start a new project/solution (alternatively, you can create a new project from command line with `dotnet` SDK) -- Add the [Grpc](https://www.nuget.org/packages/Grpc/) NuGet package as a dependency (Project options -> Manage NuGet Packages). +- Add the [Grpc](https://www.nuget.org/packages/Grpc/) NuGet package as a dependency (Project options -> Manage NuGet Packages). - To be able to generate code from Protocol Buffer (`.proto`) file definitions, add the [Grpc.Tools](https://www.nuget.org/packages/Grpc.Tools/) NuGet package which provides [code generation integrated into your build](BUILD-INTEGRATION.md). @@ -78,11 +78,11 @@ If you are a user of gRPC C#, go to Usage section above. **Windows, Linux or Mac OS X** - The easiest way to build is using the `run_tests.py` script that will take care of building the `grpc_csharp_ext` native library. - + ``` - # NOTE: make sure all necessary git submodules with dependencies + # NOTE: make sure all necessary git submodules with dependencies # are available by running "git submodule update --init" - + # from the gRPC repository root $ python tools/run_tests/run_tests.py -l csharp -c dbg --build_only ``` @@ -126,4 +126,4 @@ Internally, gRPC C# uses a native library written in C (gRPC C core) and invokes [API Reference]: https://grpc.io/grpc/csharp/api/Grpc.Core.html [Helloworld Example]: ../../examples/csharp/Helloworld -[RouteGuide Tutorial]: https://grpc.io/docs/tutorials/basic/csharp.html +[RouteGuide Tutorial]: https://grpc.io/docs/languages/csharp/basics