diff --git a/config.toml b/config.toml index dc4d88e..5ffea5c 100644 --- a/config.toml +++ b/config.toml @@ -1,4 +1,4 @@ -baseURL = "https://grpc-io.netlify.com/" +baseURL = "https://grpc.io/" languageCode = "en-us" title = "gRPC" pygmentsCodeFences = true diff --git a/content/blog/2015-10-26-principles.html b/content/blog/2015-10-26-principles.html index d2b9478..d2afe82 100644 --- a/content/blog/2015-10-26-principles.html +++ b/content/blog/2015-10-26-principles.html @@ -10,8 +10,6 @@ url: blog/beta_release The gRPC team is excited to announce the immediate availability of gRPC Beta. This release marks an important point in API stability and going forward most API changes are expected to be additive in nature. This milestone opens the door for gRPC use in production environments.

- -

We’re also taking a big step forward in improving the installation process. Over the past few weeks we’ve rolled out gRPC packages to Debian Stable/Backports. Installation in most cases is now a two line install using the Debian package and available language specific package managers (maven, pip, gem, composer, pecl, npm, nuget, pod). In addition gRPC docker images are now available on Docker Hub.

diff --git a/content/blog/2015-9-8-principles.html b/content/blog/2015-9-8-principles.html index d0cb4e1..4dd51a5 100644 --- a/content/blog/2015-9-8-principles.html +++ b/content/blog/2015-9-8-principles.html @@ -11,8 +11,6 @@ url: blog/principles

Google has been using a single general-purpose RPC infrastructure called Stubby to connect the large number of microservices running within and across our data centers for over a decade. Our internal systems have long embraced the microservice architecture gaining popularity today. Having a uniform, cross-platform RPC infrastructure has allowed for the rollout of fleet-wide improvements in efficiency, security, reliability and behavioral analysis critical to supporting the incredible growth seen in that period.

- -

Stubby has many great features - however, it's not based on any standard and is too tightly coupled to our internal infrastructure to be considered suitable for public release. With the advent of SPDY, HTTP/2, and QUIC, many of these same features have appeared in public standards, together with other features that Stubby does not provide. It became clear that it was time to rework Stubby to take advantage of this standardization, and to extend its applicability to mobile, IoT, and Cloud use-cases.

Principles & Requirements

diff --git a/content/blog/2017-09-14-meetup-kit.html b/content/blog/2017-09-14-meetup-kit.html index 6be0845..c6ce63e 100644 --- a/content/blog/2017-09-14-meetup-kit.html +++ b/content/blog/2017-09-14-meetup-kit.html @@ -8,7 +8,5 @@ url: blog/meetup-kit

If you have ever wanted to run an event around gRPC, but didn’t know where to start, or wasn’t sure what content is available - we have released the gRPC Meetup Kit!

- -

The meetup kit includes a 15 minute presentation on the basic concepts of gRPC, with accompanying slides and video for either reference or playback, as well as a 45 minute codelab that takes you through the basics of gRPC in Node.js and Go. At the end of the codelab participants will have a solid understanding of the fundamentals of gRPC.

If you are thinking about running a gRPC event, make sure to contact us to receive gRPC stickers and/or organise office hours over Hangouts with the gRPC team!

diff --git a/content/contribute/index.html b/content/contribute/index.html index 16448ae..1ad6805 100644 --- a/content/contribute/index.html +++ b/content/contribute/index.html @@ -4,7 +4,7 @@ title: Contribute
- To contribute to gRPC documentation, please fork the GitHub gRPC repository  and start submitting pull requests. + To contribute to gRPC documentation, please fork the GitHub gRPC repository  and start submitting pull requests.

Contribution guidelines for gRPC

@@ -28,7 +28,7 @@ title: Contribute

Click the below button to visit the repo for our site. You can then click the "Fork" button in the upper-right area of the screen to create a copy of our site on your GitHub account called a "fork." Make any changes you want in your fork, and when you are ready to send those changes to us, go to the index page for your fork and click "New Pull Request" to let us know about it.

- +
diff --git a/content/docs/guides/_index.md b/content/docs/guides/_index.md index 09ef36a..70effa1 100644 --- a/content/docs/guides/_index.md +++ b/content/docs/guides/_index.md @@ -1,6 +1,7 @@ --- layout: guides title: Guides +weight: 2 --- This document introduces you to gRPC and protocol buffers. gRPC can use diff --git a/content/docs/guides/auth.md b/content/docs/guides/auth.md index 2c11cce..612cbaf 100644 --- a/content/docs/guides/auth.md +++ b/content/docs/guides/auth.md @@ -1,11 +1,9 @@ --- layout: guides title: Authentication +description: | + This document provides an overview of gRPC authentication, including our built-in supported auth mechanisms, how to plug in your own authentication systems, and examples of how to use gRPC auth in our supported languages. --- -

This document provides an overview of gRPC authentication, -including our built-in supported auth mechanisms, how to plug in your own -authentication systems, and examples of how to use gRPC auth in our supported -languages.

diff --git a/content/docs/guides/benchmarking.md b/content/docs/guides/benchmarking.md index 9c31820..0298b1b 100644 --- a/content/docs/guides/benchmarking.md +++ b/content/docs/guides/benchmarking.md @@ -1,11 +1,9 @@ --- layout: guides title: Benchmarking +description: | + gRPC is designed to support high-performance open-source RPCs in many languages. This document describes the performance benchmarking tools, the scenarios considered by the tests, and the testing infrastructure. --- -

gRPC is designed to support high-performance -open-source RPCs in many languages. This document describes the -performance benchmarking tools, the scenarios considered by the tests, -and the testing infrastructure.

diff --git a/content/docs/guides/concepts.md b/content/docs/guides/concepts.md index 2ead78c..13ca462 100644 --- a/content/docs/guides/concepts.md +++ b/content/docs/guides/concepts.md @@ -1,9 +1,9 @@ --- layout: guides title: gRPC Concepts +description: | + This document introduces some key gRPC concepts with an overview of gRPC's architecture and RPC life cycle. --- -

This document introduces some key gRPC concepts with an overview -of gRPC's architecture and RPC life cycle.

It assumes that you've read [What is gRPC?](/docs/guides). For language-specific details, see the Quick Start, tutorial, and reference diff --git a/content/docs/guides/error.md b/content/docs/guides/error.md index ae2d1f3..2ee9f0d 100644 --- a/content/docs/guides/error.md +++ b/content/docs/guides/error.md @@ -1,8 +1,9 @@ --- layout: guides title: Error Handling +description: | + This page describes how gRPC deals with errors, including gRPC's built-in error codes. Example code in different languages can be found [here](https://github.com/avinassh/grpc-errors). --- -

This page describes how gRPC deals with errors, including gRPC's built-in error codes. Example code in different languages can be found here.

diff --git a/content/docs/quickstart/_index.md b/content/docs/quickstart/_index.md index 1b73b19..69c844a 100644 --- a/content/docs/quickstart/_index.md +++ b/content/docs/quickstart/_index.md @@ -1,10 +1,9 @@ --- title: Quick Start layout: quickstart +description: Get started with gRPC +weight: 1 --- -

-Get started with gRPC -

diff --git a/content/docs/quickstart/android.md b/content/docs/quickstart/android.md index d7d198b..35fa747 100644 --- a/content/docs/quickstart/android.md +++ b/content/docs/quickstart/android.md @@ -2,9 +2,8 @@ layout: quickstart title: Android Java Quickstart short: Android +description: This guide gets you started with gRPC in Android Java with a simple working example. --- -

This guide gets you started with gRPC in Android Java with a simple -working example.

diff --git a/content/docs/quickstart/cpp.md b/content/docs/quickstart/cpp.md index 489b22e..397ed26 100644 --- a/content/docs/quickstart/cpp.md +++ b/content/docs/quickstart/cpp.md @@ -2,9 +2,8 @@ layout: quickstart title: C++ Quick Start short: C++ +description: This guide gets you started with gRPC in C++ with a simple working example. --- -

This guide gets you started with gRPC in C++ with a simple -working example.

diff --git a/content/docs/quickstart/csharp.md b/content/docs/quickstart/csharp.md index 526199c..e140b3b 100644 --- a/content/docs/quickstart/csharp.md +++ b/content/docs/quickstart/csharp.md @@ -2,11 +2,9 @@ title: C# Quick Start layout: quickstart short: C# +description: This guide gets you started with gRPC in C# with a simple working example. --- -

This guide gets you started with gRPC in C# with a simple -working example.

-
### Before you begin diff --git a/content/docs/quickstart/dart.md b/content/docs/quickstart/dart.md index 8346909..9455ee8 100644 --- a/content/docs/quickstart/dart.md +++ b/content/docs/quickstart/dart.md @@ -2,9 +2,8 @@ layout: quickstart title: Dart Quickstart short: Dart +description: This guide gets you started with gRPC in Dart with a simple working example. --- -

This guide gets you started with gRPC in Dart with a simple -working example.

diff --git a/content/docs/quickstart/go.md b/content/docs/quickstart/go.md index da23196..a0747e2 100644 --- a/content/docs/quickstart/go.md +++ b/content/docs/quickstart/go.md @@ -2,9 +2,8 @@ title: Go Quick Start layout: quickstart short: Go +description: This guide gets you started with gRPC in Go with a simple working example. --- -

This guide gets you started with gRPC in Go with a simple -working example.

diff --git a/content/docs/quickstart/java.md b/content/docs/quickstart/java.md index c2f03cb..d6b4a29 100644 --- a/content/docs/quickstart/java.md +++ b/content/docs/quickstart/java.md @@ -2,9 +2,8 @@ layout: quickstart title: Java Quick Start short: Java +description: This guide gets you started with gRPC in Java with a simple working example. --- -

This guide gets you started with gRPC in Java with a simple -working example.

diff --git a/content/docs/quickstart/node.md b/content/docs/quickstart/node.md index 5c68e60..b4bf1ba 100644 --- a/content/docs/quickstart/node.md +++ b/content/docs/quickstart/node.md @@ -2,9 +2,8 @@ title: Node Quick Start layout: quickstart short: Node +description: This guide gets you started with gRPC in Node with a simple working example. --- -

This guide gets you started with gRPC in Node with a simple -working example.

diff --git a/content/docs/quickstart/objective-c.md b/content/docs/quickstart/objective-c.md index 4d90674..dfb84bc 100644 --- a/content/docs/quickstart/objective-c.md +++ b/content/docs/quickstart/objective-c.md @@ -2,9 +2,8 @@ layout: quickstart title: Objective-C Quick Start short: Objective-C +description: This guide gets you started with gRPC on the iOS platform in Objective-C with a simple working example. --- -

This guide gets you started with gRPC on the iOS platform in -Objective-C with a simple working example.

diff --git a/content/docs/quickstart/php.md b/content/docs/quickstart/php.md index 5387ec6..2b8a71a 100644 --- a/content/docs/quickstart/php.md +++ b/content/docs/quickstart/php.md @@ -2,9 +2,8 @@ layout: quickstart title: PHP Quick Start short: PHP +description: This guide gets you started with gRPC in PHP with a simple working example. --- -

This guide gets you started with gRPC in PHP with a simple -working example.

diff --git a/content/docs/quickstart/python.md b/content/docs/quickstart/python.md index e178d9f..1231bc8 100644 --- a/content/docs/quickstart/python.md +++ b/content/docs/quickstart/python.md @@ -2,9 +2,8 @@ layout: quickstart title: Python Quick Start short: Python +description: This guide gets you started with gRPC in Python with a simple working example. --- -

This guide gets you started with gRPC in Python with a simple -working example.

diff --git a/content/docs/quickstart/ruby.md b/content/docs/quickstart/ruby.md index 08c68d8..6532096 100644 --- a/content/docs/quickstart/ruby.md +++ b/content/docs/quickstart/ruby.md @@ -2,11 +2,9 @@ title: Ruby Quick Start layout: quickstart short: Ruby +description: This guide gets you started with gRPC in Ruby with a simple working example. --- -

This guide gets you started with gRPC in Ruby with a simple -working example.

-
### Before you begin diff --git a/content/docs/quickstart/web.md b/content/docs/quickstart/web.md index 70e6ebe..c3ba7fd 100644 --- a/content/docs/quickstart/web.md +++ b/content/docs/quickstart/web.md @@ -2,9 +2,8 @@ title: Web Quick Start layout: quickstart short: Web +description: This guide gets you started with gRPC-Web with a simple working example. --- -

This guide gets you started with gRPC-Web with a simple -working example from the browser.

diff --git a/content/docs/reference/_index.html b/content/docs/reference/_index.html index dc752ce..8a75d62 100644 --- a/content/docs/reference/_index.html +++ b/content/docs/reference/_index.html @@ -4,6 +4,7 @@ headline: 'Language Specific API Reference' layout: docs title: Reference type: markdown +weight: 4 ---

Links to the language specific automatically generated API reference documentation.

diff --git a/content/docs/samples/_index.md b/content/docs/samples/_index.md index 4e8575f..5434ebf 100644 --- a/content/docs/samples/_index.md +++ b/content/docs/samples/_index.md @@ -4,7 +4,9 @@ headline: 'gRPC Samples' layout: docs title: Samples type: markdown +weight: 5 --- +

Here are some sample apps to help developers build certain functionalities

    diff --git a/content/docs/talks/_index.md b/content/docs/talks/_index.md index 2d20af8..1177932 100644 --- a/content/docs/talks/_index.md +++ b/content/docs/talks/_index.md @@ -1,7 +1,9 @@ --- layout: docs title: Presentations & Talks +short: Presentations type: markdown +weight: 6 ---

    gRPC has been talked about in many conferences and sessions. Here are a few interesting ones:

    diff --git a/content/docs/tutorials/_index.md b/content/docs/tutorials/_index.md index 7d3e5a6..b0acb13 100644 --- a/content/docs/tutorials/_index.md +++ b/content/docs/tutorials/_index.md @@ -1,12 +1,13 @@ --- layout: tutorials title: Tutorials +weight: 3 --- This section contains tutorials for each of our supported languages. They introduce you to gRPC's API and associated concepts, and the different RPC types that are available. If you just want to dive straight in with a working example -first, see our [Quickstarts](/docs/quickstart). +first, see our [Quick Starts](/docs/quickstart). We also have a growing number of tutorials on follow-on topics, with more in the pipeline. diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html index d0668c5..42e70bf 100644 --- a/layouts/_default/baseof.html +++ b/layouts/_default/baseof.html @@ -35,8 +35,8 @@
    diff --git a/layouts/docs/quickstart.html b/layouts/docs/quickstart.html index 30cab2c..de07705 100644 --- a/layouts/docs/quickstart.html +++ b/layouts/docs/quickstart.html @@ -20,10 +20,6 @@ Quick Start - - Quick Start Home - - {{ range $quickstartDocs }} {{ $isCurrentPage := eq $currentUrl .RelPermalink }} {{ $title := .Params.short }} @@ -35,8 +31,13 @@

    {{ .Title }}

    + {{ with .Params.description }} +

    + {{ . | markdownify }} +

    + {{ end }} - {{ .Content }} + {{ .Content }}
diff --git a/layouts/docs/tutorials.html b/layouts/docs/tutorials.html index c6c878d..6fd2cd3 100644 --- a/layouts/docs/tutorials.html +++ b/layouts/docs/tutorials.html @@ -33,7 +33,7 @@ {{ range $async }} {{ $isCurrentPage := eq $currentUrl .RelPermalink }} {{ $title := .Params.short }} - + {{ $title }} {{ end }} @@ -43,7 +43,7 @@ {{ range $basic }} {{ $isCurrentPage := eq $currentUrl .RelPermalink }} {{ $title := .Params.short }} - + {{ $title }} {{ end }} @@ -52,8 +52,13 @@

{{ .Title }}

+ {{ with .Params.description }} +

+ {{ . | markdownify }} +

+ {{ end }} - {{ .Content }} + {{ .Content }}
diff --git a/layouts/partials/docs-topnav.html b/layouts/partials/docs-topnav.html index c80e149..5fa32be 100644 --- a/layouts/partials/docs-topnav.html +++ b/layouts/partials/docs-topnav.html @@ -1,9 +1,17 @@ +{{ $docsSections := (index (where site.Sections "Section" "docs") 0).Sections }} +{{ $isDocsHome := eq .RelPermalink "/docs/" }} +{{ $currentSection := .CurrentSection.Title }}
- Overview -| Quick Start -| Guides -| Tutorials -| Reference -| Samples -| Presentations + + Overview + + + {{ range $docsSections }} + {{ $isCurrentSection := eq $currentSection .CurrentSection.Title }} + {{ $title := cond (isset .Params "short") .Params.short .Title }} + | + + {{ $title }} + + {{ end }}