Skip to content
This repository was archived by the owner on Apr 9, 2021. It is now read-only.

Commit 13ac1d1

Browse files
Merge pull request #719 from carl-mastrangelo/taggy
Use gRPC tags rather than branches in docs
2 parents 9420398 + bde47c8 commit 13ac1d1

22 files changed

Lines changed: 87 additions & 87 deletions

_data/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
grpc_release_branch: v1.14.x
1+
grpc_release_tag: v1.14.0
22
grpc_java_release_tag: v1.14.0
33
milestones_link: https://github.com/grpc/grpc/milestones

_includes/c-lang-list.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<a href="https://github.com/grpc/grpc">C</a>,
2-
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_branch }}/src/cpp">C++</a>,
3-
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_branch }}/src/node">Node.js</a>,
4-
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_branch }}/src/python">Python</a>,
5-
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_branch }}/src/ruby">Ruby</a>,
6-
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_branch }}/src/objective-c">Objective-C</a>,
7-
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_branch }}/src/php">PHP</a> and
8-
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_branch }}/src/csharp">C#</a>.
2+
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_tag }}/src/cpp">C++</a>,
3+
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_tag }}/src/node">Node.js</a>,
4+
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_tag }}/src/python">Python</a>,
5+
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_tag }}/src/ruby">Ruby</a>,
6+
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_tag }}/src/objective-c">Objective-C</a>,
7+
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_tag }}/src/php">PHP</a> and
8+
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_tag }}/src/csharp">C#</a>.

_includes/lang-list.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<a href="https://github.com/grpc/grpc">C</a>,
2-
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_branch }}/src/cpp">C++</a>,
3-
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_branch }}/src/csharp">C#</a>,
2+
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_tag }}/src/cpp">C++</a>,
3+
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_tag }}/src/csharp">C#</a>,
44
<a href="https://github.com/grpc/grpc-dart">Dart</a>,
55
<a href="https://github.com/grpc/grpc-go">Go</a>,
66
<a href="https://github.com/grpc/grpc-java">Java</a>,
7-
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_branch }}/src/node">Node.js</a>,
8-
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_branch }}/src/objective-c">Objective-C</a>,
9-
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_branch }}/src/php">PHP</a>,
10-
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_branch }}/src/python/grpcio">Python</a>, and
11-
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_branch }}/src/ruby">Ruby</a>.
7+
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_tag }}/src/node">Node.js</a>,
8+
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_tag }}/src/objective-c">Objective-C</a>,
9+
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_tag }}/src/php">PHP</a>,
10+
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_tag }}/src/python/grpcio">Python</a>, and
11+
<a href="https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_tag }}/src/ruby">Ruby</a>.

_posts/2016-4-4-installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Go | Linux, Mac, Windows | `go get google.golang.org/grpc`
3232
Objective-C | Mac | Runtime source fetched automatically from Github by Cocoapods
3333
C# | Windows | Install [gRPC NuGet package](https://www.nuget.org/packages/Grpc/) from your IDE (Visual Studio, Monodevelop, Xamarin Studio)
3434
Java | Linux, Mac, Windows | Use our [Maven and Gradle plugins](https://github.com/grpc/grpc-java/blob/master/README.md) that provide gRPC with [statically linked `boringssl`](https://github.com/grpc/grpc-java/blob/master/SECURITY.md#openssl-statically-linked-netty-tcnative-boringssl-static)
35-
C++ | Linux, Mac, Windows | Currently requires [manual build and install](https://github.com/grpc/grpc/blob/{{ site.data.config.grpc_release_branch }}/INSTALL.md)
35+
C++ | Linux, Mac, Windows | Currently requires [manual build and install](https://github.com/grpc/grpc/blob/{{ site.data.config.grpc_release_tag }}/INSTALL.md)
3636

3737
You can find out more about installation in our [Getting Started guide](/docs/#install-grpc) and Github repositories. Do send us your feedback on our [mailing list](https://groups.google.com/forum/#!forum/grpc-io) or file issues on our issue tracker if you run into any problems.
3838

docs/quickstart/csharp.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ and other tutorials):
5555

5656
```sh
5757
$ # Clone the repository to get the example code:
58-
$ git clone -b {{ site.data.config.grpc_release_branch }} https://github.com/grpc/grpc
58+
$ git clone -b {{ site.data.config.grpc_release_tag }} https://github.com/grpc/grpc
5959
$ cd grpc
6060
```
6161

@@ -212,7 +212,7 @@ The `Grpc.Tools` NuGet package contains the protoc and protobuf C# plugin binari
212212

213213
#### Using Visual Studio
214214

215-
This example project already depends on the `Grpc.Tools.{{ site.data.config.grpc_release_branch | remove_first: "v" }}` NuGet package, so it should be included in `examples/csharp/helloworld/packages` when the `Greeter.sln` solution is built from your IDE,
215+
This example project already depends on the `Grpc.Tools.{{ site.data.config.grpc_release_tag | remove_first: "v" }}` NuGet package, so it should be included in `examples/csharp/helloworld/packages` when the `Greeter.sln` solution is built from your IDE,
216216
or when you restore packages via `/path/to/nuget restore` on the command line.
217217

218218
#### If you have a NuGet client that is __not__ at version 2.12
@@ -230,8 +230,8 @@ is by simply downloading the NuGet package and unzipping without a NuGet client,
230230
From your example directory:
231231

232232
```
233-
$ temp_dir=packages/Grpc.Tools.{{ site.data.config.grpc_release_branch | remove_first: "v" }}/tmp
234-
$ curl_url=https://www.nuget.org/api/v2/package/Grpc.Tools/{{ Grpc.Tools.{{ site.data.config.grpc_release_branch | remove_first: "v" }}
233+
$ temp_dir=packages/Grpc.Tools.{{ site.data.config.grpc_release_tag | remove_first: "v" }}/tmp
234+
$ curl_url=https://www.nuget.org/api/v2/package/Grpc.Tools/{{ Grpc.Tools.{{ site.data.config.grpc_release_tag | remove_first: "v" }}
235235
$ mkdir -p $temp_dir && cd $temp_dir && curl -sL $curl_url > tmp.zip; unzip tmp.zip && cd .. && cp -r tmp/tools . && rm -rf tmp && cd ../..
236236
```
237237

@@ -247,13 +247,13 @@ From the `examples/csharp/helloworld` directory, or the `examples/csharp/hellowo
247247
**Windows**
248248

249249
```
250-
> packages\Grpc.Tools.{{ site.data.config.grpc_release_branch | remove_first: "v" }}\tools\windows_x86\protoc.exe -I../../protos --csharp_out Greeter --grpc_out Greeter ../../protos/helloworld.proto --plugin=protoc-gen-grpc=packages/Grpc.Tools.{{ site.data.config.grpc_release_branch | remove_first: "v" }}/tools/windows_x86/grpc_csharp_plugin.exe
250+
> packages\Grpc.Tools.{{ site.data.config.grpc_release_tag | remove_first: "v" }}\tools\windows_x86\protoc.exe -I../../protos --csharp_out Greeter --grpc_out Greeter ../../protos/helloworld.proto --plugin=protoc-gen-grpc=packages/Grpc.Tools.{{ site.data.config.grpc_release_tag | remove_first: "v" }}/tools/windows_x86/grpc_csharp_plugin.exe
251251
```
252252

253253
**Linux (or OS X by using macosx_x64 directory)**
254254

255255
```
256-
$ packages/Grpc.Tools.{{ site.data.config.grpc_release_branch | remove_first: "v" }}/tools/linux_x64/protoc -I../../protos --csharp_out Greeter --grpc_out Greeter ../../protos/helloworld.proto --plugin=protoc-gen-grpc=packages/Grpc.Tools.{{ site.data.config.grpc_release_branch | remove_first: "v" }}/tools/linux_x64/grpc_csharp_plugin
256+
$ packages/Grpc.Tools.{{ site.data.config.grpc_release_tag | remove_first: "v" }}/tools/linux_x64/protoc -I../../protos --csharp_out Greeter --grpc_out Greeter ../../protos/helloworld.proto --plugin=protoc-gen-grpc=packages/Grpc.Tools.{{ site.data.config.grpc_release_tag | remove_first: "v" }}/tools/linux_x64/grpc_csharp_plugin
257257
```
258258

259259
Running the appropriate command for your OS regenerates the following files in

docs/quickstart/node.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ and other tutorials):
2626

2727
```sh
2828
$ # Clone the repository to get the example code
29-
$ git clone -b {{ site.data.config.grpc_release_branch }} https://github.com/grpc/grpc
29+
$ git clone -b {{ site.data.config.grpc_release_tag }} https://github.com/grpc/grpc
3030
$ # Navigate to the dynamic codegen "hello, world" Node example:
3131
$ cd grpc/examples/node/dynamic_codegen
3232
$ # Install the example's dependencies

docs/quickstart/objective-c.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Quickstart. Copy the source code from Github
5757
[repository](https://github.com/grpc/grpc):
5858

5959
```sh
60-
$ git clone --recursive -b {{ site.data.config.grpc_release_branch }} https://github.com/grpc/grpc.git
60+
$ git clone --recursive -b {{ site.data.config.grpc_release_tag }} https://github.com/grpc/grpc.git
6161
```
6262

6363
## Install gRPC plugins and libraries

docs/quickstart/php.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ e.g. [Node.js](node-quickstart.md).
269269

270270
```sh
271271
$ # Clone the repository to get the example code:
272-
$ git clone -b {{ site.data.config.grpc_release_branch }} https://github.com/grpc/grpc
272+
$ git clone -b {{ site.data.config.grpc_release_tag }} https://github.com/grpc/grpc
273273
$ # Build grpc_php_plugin to generate proto files if not build before
274274
$ cd grpc && git submodule update --init && make grpc_php_plugin
275275
$ # Navigate to the "hello, world" PHP example:

docs/quickstart/python.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Python's gRPC tools include the protocol buffer compiler `protoc` and the
6464
special plugin for generating server and client code from `.proto` service
6565
definitions. For the first part of our quickstart example, we've already
6666
generated the server and client stubs from
67-
[helloworld.proto](https://github.com/grpc/grpc/tree/{{site.data.config.grpc_release_branch}}/examples/protos/helloworld.proto),
67+
[helloworld.proto](https://github.com/grpc/grpc/tree/{{site.data.config.grpc_release_tag}}/examples/protos/helloworld.proto),
6868
but you'll need the tools for the rest of our quickstart, as well as later
6969
tutorials and your own projects.
7070

@@ -83,7 +83,7 @@ and other tutorials):
8383

8484
```sh
8585
$ # Clone the repository to get the example code:
86-
$ git clone -b {{ site.data.config.grpc_release_branch }} https://github.com/grpc/grpc
86+
$ git clone -b {{ site.data.config.grpc_release_tag }} https://github.com/grpc/grpc
8787
$ # Navigate to the "hello, world" Python example:
8888
$ cd grpc/examples/python/helloworld
8989
```

docs/quickstart/ruby.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Ruby's gRPC tools include the protocol buffer compiler `protoc` and the special
2929
plugin for generating server and client code from the `.proto` service
3030
definitions. For the first part of our quickstart example, we've already
3131
generated the server and client stubs from
32-
[helloworld.proto](https://github.com/grpc/grpc/tree/{{site.data.config.grpc_release_branch}}/examples/protos/helloworld.proto),
32+
[helloworld.proto](https://github.com/grpc/grpc/tree/{{site.data.config.grpc_release_tag}}/examples/protos/helloworld.proto),
3333
but you'll need the tools for the rest of our quickstart, as well as later
3434
tutorials and your own projects.
3535

@@ -48,7 +48,7 @@ and other tutorials):
4848

4949
```sh
5050
$ # Clone the repository to get the example code:
51-
$ git clone -b {{ site.data.config.grpc_release_branch }} https://github.com/grpc/grpc
51+
$ git clone -b {{ site.data.config.grpc_release_tag }} https://github.com/grpc/grpc
5252
$ # Navigate to the "hello, world" Ruby example:
5353
$ cd grpc/examples/ruby
5454
```

0 commit comments

Comments
 (0)