Skip to content

Commit c00e9fc

Browse files
aidanranneyaidanranney
authored
Address fixes and add meta (GitHub) links to pages (#578)
* Fixup to make comment consistent with others * Replace missing FA icon with equivalent * Render SVGs with Markdown and restore alt text to an image * Give used-by user logos equal padding * Fix border radius on search inputs * Add meta links to all pages * Fix overflow issue from covering link's content box * Fix spacing issue on icon links in production
1 parent 8e4f008 commit c00e9fc

File tree

15 files changed

+98
-22
lines changed

15 files changed

+98
-22
lines changed

‎assets/scss/_grpc.scss

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ sections site wide to the original site's background svg.
3636
display: none;
3737
}
3838

39+
// This adds rounded corners to the search inputs, since a Docsy
40+
// flag affecting these and other elements has been disabled.
41+
.td-search-input {
42+
border-radius: 1rem;
43+
}
44+
3945
// DOCS
4046

4147
// Extend the sidebar to the end of the visible page.
@@ -142,6 +148,7 @@ c - Component (Aware of its content/context...)
142148
.l-constrained-width-content {
143149
margin-left: auto;
144150
margin-right: auto;
151+
padding-bottom: 1rem;
145152
max-width: 1140px;
146153
}
147154

@@ -182,6 +189,10 @@ c - Component (Aware of its content/context...)
182189
}
183190
}
184191

192+
.o-icon {
193+
margin-right: 0.25rem;
194+
}
195+
185196
.o-logo {
186197
width: 80%;
187198
}
@@ -279,6 +290,22 @@ c - Component (Aware of its content/context...)
279290
justify-content: center;
280291
}
281292

293+
.c-global-meta-links {
294+
margin-top: 1rem;
295+
padding-top: 1rem;
296+
297+
.td-page-meta {
298+
display: flex;
299+
justify-content: space-between;
300+
margin-left: 0 !important;
301+
text-align: center;
302+
303+
& a i {
304+
display: none;
305+
}
306+
}
307+
}
308+
282309
.c-used-by__users {
283310
display: flex;
284311
flex-direction: column;
@@ -289,6 +316,7 @@ c - Component (Aware of its content/context...)
289316
.c-used-by__user {
290317
margin-left: auto;
291318
margin-right: auto;
319+
padding-left: 1.5rem;
292320
padding-right: 1.5rem;
293321
padding-bottom: 3rem;
294322
}
@@ -326,6 +354,12 @@ c - Component (Aware of its content/context...)
326354
}
327355
}
328356

357+
.c-global-meta-links {
358+
& .td-page-meta a i {
359+
display: inline-block;
360+
}
361+
}
362+
329363
.c-used-by__users {
330364
flex-direction: row;
331365
justify-content: between;
@@ -335,3 +369,15 @@ c - Component (Aware of its content/context...)
335369
padding-bottom: 1.5rem;
336370
}
337371
}
372+
373+
@include media-breakpoint-up(lg) {
374+
.c-global-meta-links {
375+
max-width: 80%;
376+
}
377+
}
378+
379+
@include media-breakpoint-up(xl) {
380+
.c-global-meta-links {
381+
display: none;
382+
}
383+
}

‎content/en/about/_index.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,12 @@ description: Who is using gRPC and why
88
{{< /blocks/cover >}}
99

1010
<div class="container l-container--padded">
11-
<div class="row">
1211

12+
<div class="row">
1313
{{< page/toc collapsed=true placement="inline" >}}
14+
</div>
1415

16+
<div class="row">
1517
<div class="col-12 col-lg-8">
1618

1719
gRPC is a modern open source high performance RPC framework that can run in any
@@ -70,4 +72,7 @@ See [Official support](/docs/#official-support).
7072
{{< page/toc placement="sidebar" >}}
7173

7274
</div>
75+
76+
{{< page/page-meta-links >}}
77+
7378
</div>

‎content/en/blog/grpc-on-dotnetcore.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,19 +41,19 @@ The implementations coexist side-by-side and each has its own advantages in term
4141

4242
Unlike the existing C-Core based implementation ([Grpc.Core](https://github.com/grpc/grpc/tree/master/src/csharp)), the new libraries ([grpc-dotnet](https://github.com/grpc/grpc-dotnet)) make use of the existing networking primitives in the .NET Core Base Class Libraries (BCL). The diagram below highlights the difference between the existing **Grpc.Core** library and the new **grpc-dotnet** libraries.
4343

44-
<p><img src="/img/grpc-dotnet.svg" alt="gRPC .NET Stack" /></p>
44+
![gRPC .NET Stack](/img/grpc-dotnet.svg)
4545

4646
On the server side, the `Grpc.AspNetCore.Server` package integrates into ASP.NET Core, allowing developers to benefit from ecosystem of common cross-cutting concerns of logging, configuration, dependency injection, authentication, authorization etc. which have already been solved by ASP.NET Core. Popular libraries in the ASP.NET ecosystem such as [Entity Framework Core (ORM)](https://github.com/aspnet/EntityFrameworkCore), [Serilog (Logging library)](https://github.com/serilog/serilog), and [Identity Server](https://github.com/IdentityServer/IdentityServer4) among others now work seamlessly with gRPC.
4747

4848
On the client side, the `Grpc.Net.Client` package builds upon the familiar `HttpClient` API that ships as part of .NET Core. As with the server, gRPC clients greatly benefit from the ecosystem of packages that build upon `HttpClient`. It is now possible to use existing packages such as [**Polly**(Resilience and fault-handling library)](https://github.com/App-vNext/Polly) and [HttpClientFactory(manage HTTPClient lifetimes)](https://docs.microsoft.com/aspnet/core/fundamentals/http-requests) with gRPC clients.
4949

5050
The diagram below captures the exhaustive list of all new .NET packages for gRPC and their relationship with the existing packages.
5151

52-
<p><img src="/img/grpc-dotnet-packages.svg" alt="grpc-dotnet packages" /></p>
52+
![grpc-dotnet packages](/img/grpc-dotnet-packages.svg)
5353

5454
In addition to the newly published packages that ship as part of **grpc-dotnet**, we've also made improvements that benefit both stacks. Visual Studio 2019 ships with language grammar support for protobuf files and automatic generation of gRPC server/client code upon saving a protobuf file without requiring full project rebuilds due to design-time builds.
5555

56-
<p><img src="/img/grpc-visualstudio.png" alt="gRPC in Visual Studio 2019" /></p>
56+
![gRPC in Visual Studio 2019](/img/grpc-visualstudio.png)
5757

5858
## Feedback
5959

‎content/en/blog/state-of-grpc-web.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The basic idea is to have the browser send normal HTTP requests (with Fetch or
5656
XHR) and have a small proxy in front of the gRPC server to translate the
5757
requests and responses to something the browser can use.
5858

59-
![](/img/grpc-web-proxy.png)
59+
![The role of the gRPC-Web proxy](/img/grpc-web-proxy.png)
6060

6161
# The Two Implementations
6262

‎content/en/community/_index.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,12 @@ title: Community
77
{{< /blocks/cover >}}
88

99
<div class="container l-container--padded">
10-
<div class="row">
1110

11+
<div class="row">
1212
{{< page/toc collapsed=true placement="inline" >}}
13+
</div>
1314

15+
<div class="row">
1416
<div class="col-12 col-lg-8">
1517
<div>
1618

@@ -61,4 +63,7 @@ We hold a community video conference every other week. It's a way to discuss the
6163
{{< page/toc placement="sidebar" >}}
6264

6365
</div>
66+
67+
{{< page/page-meta-links >}}
68+
6469
</div>

‎content/en/docs/languages/go/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ spelling: cSpell:ignore Isberner Klerk Malte youtube
2525
- **[Stubbing gRPC in Go](https://jadekler.github.io/2020/10/08/stubbing-grpc.html)**,
2626
by [Jean de Klerk](https://github.com/jadekler), Google. October 8, 2020.
2727
- **Talking to Go gRPC Services Via HTTP/1**
28-
<a class="icon" href="https://youtu.be/Vbw8h0RCn2E"><i class="fab fa-youtube"></i></a>
29-
<a class="icon" href="https://static.sched.com/hosted_files/grpcconf20/c9/TalkingToGoGRPCviaHTTP1-gRPCConf2020-MalteIsberner.pdf"><i class="far fa-file"></i></a><br>
28+
<a class="o-icon" href="https://youtu.be/Vbw8h0RCn2E"><i class="fab fa-youtube"></i></a>
29+
<a class="o-icon" href="https://static.sched.com/hosted_files/grpcconf20/c9/TalkingToGoGRPCviaHTTP1-gRPCConf2020-MalteIsberner.pdf"><i class="fas fa-file"></i></a><br>
3030
A [gRPC Conf 2020 presentation](https://sched.co/cRfW)
3131
by Malte Isberner, StackRox.
3232

‎content/en/docs/languages/java/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ content:
2828
by Nikos Katirtzis, Software Engineer, [Hotels.com][],
2929
<span title="2020-03-05">March 2020</span>.
3030
- Service Interoperability With gRPC: gRPC in Action
31-
<a class="icon" href="https://youtu.be/MLS7TFHrn_c"><i class="fab fa-youtube"></i>
32-
</a><a class="icon" href="https://static.sched.com/hosted_files/grpcconf20/d3/Service%20Interoperability%20with%20gRPC.pdf"><i class="far fa-file"></i></a><br>
31+
<a class="o-icon" href="https://youtu.be/MLS7TFHrn_c"><i class="fab fa-youtube"></i>
32+
</a><a class="o-icon" href="https://static.sched.com/hosted_files/grpcconf20/d3/Service%20Interoperability%20with%20gRPC.pdf"><i class="fas fa-file"></i></a><br>
3333
A [gRPC Conf 2020 presentation](https://sched.co/cRfl)
3434
by Varun Gupta & Tuhin Kanti Sharma, Salesforce.
3535
- gRPC and Java Diamond Dependency Conflicts
36-
<a class="icon" href="https://youtu.be/4M5fC9XrtKs">
36+
<a class="o-icon" href="https://youtu.be/4M5fC9XrtKs">
3737
<i class="fab fa-youtube"></i>
38-
</a><a class="icon" href="https://static.sched.com/hosted_files/grpcconf20/7a/gRPC%20and%20Java%20Diamond%20Dependency%20Conflicts.pdf"><i class="far fa-file"></i></a><br>
38+
</a><a class="o-icon" href="https://static.sched.com/hosted_files/grpcconf20/7a/gRPC%20and%20Java%20Diamond%20Dependency%20Conflicts.pdf"><i class="fas fa-file"></i></a><br>
3939
A [gRPC Conf 2020 presentation](https://sched.co/cRfT)
4040
by Tomo Suzuki, Google.
4141

‎content/en/docs/languages/kotlin/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ spelling: cSpell:ignore Ferrer youtube
2020
### Developer stories and talks {#dev-stories}
2121

2222
- **Next Level gRPC With Kotlin and Coroutines**
23-
<a class="icon" href="https://youtu.be/SfmdAA2kwWI"><i class="fab fa-youtube"></i></a>
24-
<a class="icon" href="https://static.sched.com/hosted_files/grpcconf20/e6/grpc-session.pdf"><i class="far fa-file"></i></a><br>
23+
<a class="o-icon" href="https://youtu.be/SfmdAA2kwWI"><i class="fab fa-youtube"></i></a>
24+
<a class="o-icon" href="https://static.sched.com/hosted_files/grpcconf20/e6/grpc-session.pdf"><i class="fas fa-file"></i></a><br>
2525
A [gRPC Conf 2020 presentation](https://sched.co/cRfc)
2626
by Marco Ferrer, OfferUp.

‎content/en/showcase/_index.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,18 @@ spelling: cSpell:ignore youtube Kubernetes Nulab Protop
1010
{{< /blocks/cover >}}
1111

1212
<div class="container l-container--padded">
13-
<div class="row">
1413

14+
<div class="row">
1515
{{< page/toc collapsed=true placement="inline" >}}
16+
</div>
1617

18+
<div class="row">
1719
<div class="col-12 col-lg-8">
1820

21+
<div class="row">
22+
1923
## Customer success stories
24+
</div>
2025

2126
Here are a few of the customers who [successfully adopted **gRPC**][use-of-grpc]
2227
and other [CNCF technologies](https://www.cncf.io/projects/) in the past year
@@ -120,18 +125,18 @@ Other developer stories are provided next.
120125
- [**How GIPHY’s Public API Integrates with gRPC Services**](https://engineering.giphy.com/how-giphys-public-api-integrates-with-grpc-services/)<br>
121126
by Serhii Kushch. August 13, 2020.
122127
- **A Simplified Service Mesh With gRPC**
123-
<a href="https://youtu.be/9alMEeTxsMA"><i class="fab fa-youtube"></i></a>
128+
<a class="o-icon" href="https://youtu.be/9alMEeTxsMA"><i class="fab fa-youtube"></i></a>
124129
<a href="https://static.sched.com/hosted_files/grpcconf20/ae/A%20Simplified%20Service%20Mesh%20with%20gRPC.pdf"><i class="fas fa-file"></i></a><br>
125130
A [gRPC Conf 2020 presentation](https://sched.co/cRfZ)
126131
by Srini Polavarapu, Engineering Manager, Google
127132
- **Protop: A Package Manager for gRPC and Protocol Buffers**
128-
<a href="https://youtu.be/9alMEeTxsMA"><i class="fab fa-youtube"></i></a>
133+
<a class="o-icon" href="https://youtu.be/9alMEeTxsMA"><i class="fab fa-youtube"></i></a>
129134
<a href="https://static.sched.com/hosted_files/grpcconf20/6b/protop%20-%20a%20package%20manager%20for%20protobufs.pdf"><i class="fas fa-file"></i></a><br>
130135
A [gRPC Conf 2020 presentation](https://sched.co/cRfo)
131136
by Jeffery Shivers, Toast, Inc
132137
- **Service Interoperability With gRPC: gRPC in Action**
133-
<a href="https://youtu.be/MLS7TFHrn_c"><i class="fab fa-youtube"></i></a>
134-
<a href="https://static.sched.com/hosted_files/grpcconf20/d3/Service%20Interoperability%20with%20gRPC.pdf"><i class="fas fa-file"></i></a><br>
138+
<a class="o-icon" href="https://youtu.be/MLS7TFHrn_c"><i class="fab fa-youtube"></i></a>
139+
<a class="o-icon" href="https://static.sched.com/hosted_files/grpcconf20/d3/Service%20Interoperability%20with%20gRPC.pdf"><i class="fas fa-file"></i></a><br>
135140
A [gRPC Conf 2020 presentation](https://sched.co/cRfl)
136141
by Varun Gupta & Tuhin Kanti Sharma, Salesforce.
137142

@@ -146,6 +151,9 @@ Other developer stories are provided next.
146151
{{< page/toc placement="sidebar" >}}
147152

148153
</div>
154+
155+
{{< page/page-meta-links >}}
156+
149157
</div>
150158

151159
[CNCF case studies]: https://www.cncf.io/case-studies/

‎layouts/404.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{{/* This file is in place as an override to the Docsy theme */}}
1+
{{/* This file is in place as an override to Docsy */}}
22

33
{{/* cSpell:ignore URL's */}}
44
{{ define "title" -}}

0 commit comments

Comments
 (0)