Skip to content

Commit a22a19f

Browse files
committed
fix markdown
1 parent dd109da commit a22a19f

File tree

15 files changed

+33
-35
lines changed

15 files changed

+33
-35
lines changed

doc/server_side_auth.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The contents of the *auth properties* are populated by an *auth interceptor*. Th
1313

1414
WARNING: AuthContext is the only reliable source of truth when it comes to authenticating RPCs. Using any other call/context properties for authentication purposes is wrong and inherently unsafe.
1515

16-
####Example AuthContext contents
16+
#### Example AuthContext contents
1717

1818
For secure channel using mutual TLS authentication with both client and server certificates (test certificates from this repository are used).
1919

@@ -45,7 +45,7 @@ gRPC comes with some basic "interceptors" already built-in.
4545
WARNING: While there is a public API that allows anyone to write their own custom interceptor, please think twice before using it.
4646
There are legitimate uses for custom interceptors but you should keep in mind that as auth interceptors essentially decide which RPCs are authenticated and which are not, their code is very sensitive from the security perspective and getting things wrong might have serious consequences. If unsure, we strongly recommend to rely on official & proven interceptors that come with gRPC.
4747

48-
####Available auth interceptors
48+
#### Available auth interceptors
4949
- TLS/SSL certificate authentication (built into gRPC's security layer, automatically used whenever you use a secure connection)
5050
- (coming soon) JWT auth token authentication
5151
- more will be added over time

examples/cpp/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#gRPC in 3 minutes (C++)
1+
# gRPC in 3 minutes (C++)
22

33
## Installation
44

examples/cpp/cpptutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#gRPC Basics: C++
1+
# gRPC Basics: C++
22

33
This tutorial provides a basic C++ programmer's introduction to working with
44
gRPC. By walking through this example you'll learn how to:

examples/csharp/route_guide/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#gRPC Basics: C# sample code
1+
# gRPC Basics: C# sample code
22

33
The files in this folder are the samples used in [gRPC Basics: C#][],
44
a detailed tutorial for using gRPC in C#.

examples/node/dynamic_codegen/route_guide/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#gRPC Basics: Node.js sample code
1+
# gRPC Basics: Node.js sample code
22

33
The files in this folder are the samples used in [gRPC Basics: Node.js][], a detailed tutorial for using gRPC in Node.js.
44

examples/node/static_codegen/route_guide/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#gRPC Basics: Node.js sample code
1+
# gRPC Basics: Node.js sample code
22

33
The files in this folder are the samples used in [gRPC Basics: Node.js][], a detailed tutorial for using gRPC in Node.js.
44

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
#OAuth2 on gRPC: Objective-C
1+
# OAuth2 on gRPC: Objective-C
22

33
This is the supporting code for the tutorial "[OAuth2 on gRPC: Objective-C](http://www.grpc.io/docs/tutorials/auth/oauth2-objective-c.html)."

examples/objective-c/helloworld/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#gRPC in 3 minutes (Objective-C)
1+
# gRPC in 3 minutes (Objective-C)
22

33
## Installation
44

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#gRPC Basics: Objective-C
1+
# gRPC Basics: Objective-C
22

33
This is the supporting code for the tutorial "[gRPC Basics: Objective-C](http://www.grpc.io/docs/tutorials/basic/objective-c.html)."
44

examples/php/route_guide/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#gRPC Basics: PHP sample code
1+
# gRPC Basics: PHP sample code
22

33
The files in this folder are the samples used in [gRPC Basics: PHP][],
44
a detailed tutorial for using gRPC in PHP.

examples/ruby/errors_and_cancellation/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#Errors and Cancelletion code samples for grpc-ruby
1+
# Errors and Cancelletion code samples for grpc-ruby
22

33
The examples in this directory show use of grpc errors.
44

examples/ruby/route_guide/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#gRPC Basics: Ruby sample code
1+
# gRPC Basics: Ruby sample code
22

33
The files in this folder are the samples used in [gRPC Basics: Ruby][],
44
a detailed tutorial for using gRPC in Ruby.

tools/grift/README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,24 @@
1-
Copyright 2016 Google Inc.
2-
3-
#Documentation
1+
# Documentation
42

53
grift is integration of [Apache Thrift](https://github.com/apache/thrift.git) Serializer with gRPC.
64

75
This integration allows you to use grpc to send thrift messages in C++ and java.
86

97
grift uses Compact Protocol to serialize thrift messages.
108

11-
##generating grpc plugins for thrift services
9+
## generating grpc plugins for thrift services
1210

13-
###CPP
11+
### C++
1412
```sh
1513
$ thrift --gen cpp <thrift-file>
1614
```
1715

18-
###JAVA
16+
### Java
1917
```sh
2018
$ thrift --gen java <thrift-file>
2119
```
2220

23-
#Installation
21+
# Installation
2422

2523
Before Installing thrift make sure to apply this [patch](grpc_plugins_generator.patch) to third_party/thrift.
2624
Go to third_party/thrift and follow the [INSTALLATION](https://github.com/apache/thrift.git) instructions to install thrift with commit id bcad91771b7f0bff28a1cac1981d7ef2b9bcef3c.

tools/run_tests/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,44 @@
1-
#Overview
1+
# Overview
22

33
This directory contains scripts that facilitate building and running tests. We are using python scripts as entrypoint for our
44
tests because that gives us the opportunity to run tests using the same commandline regardless of the platform you are using.
55

6-
#Unit tests (run_tests.py)
6+
# Unit tests (run_tests.py)
77

88
Builds gRPC in given language and runs unit tests. Use `tools/run_tests/run_tests.py --help` for more help.
99

10-
######Example
10+
###### Example
1111
`tools/run_tests/run_tests.py -l csharp -c dbg`
1212

13-
######Useful options (among many others)
13+
###### Useful options (among many others)
1414
- `--use_docker` Builds a docker container containing all the prerequisites for given language and runs the tests under that container.
1515
- `--build_only` Only build, do not run the tests.
1616

17-
#Interop tests (run_interop_tests.py)
17+
# Interop tests (run_interop_tests.py)
1818

1919
Runs tests for cross-platform/cross-language interoperability. For more details, see [Interop tests descriptions](/doc/interop-test-descriptions.md)
2020
The script is also capable of running interop tests for grpc-java and grpc-go, using sources checked out alongside the ones of the grpc repository.
2121

22-
######Example
22+
###### Example
2323
`tools/run_tests/run_interop_tests.py -l csharp -s c++ --use_docker` (run interop tests with C# client and C++ server)
2424

2525
Note: if you see an error like `no space left on device` when running the
2626
interop tests using Docker, make sure that Docker is building the image files in
2727
a location with sufficient disk space.
2828

29-
#Performance benchmarks (run_performance_tests.py)
29+
# Performance benchmarks (run_performance_tests.py)
3030

3131
Runs predefined benchmark scenarios for given languages. Besides the simple configuration of running all the scenarios locally,
3232
the script also supports orchestrating test runs with client and server running on different machines and uploading the results
3333
to BigQuery.
3434

35-
######Example
35+
###### Example
3636
`tools/run_tests/run_peformance_tests.py -l c++ node`
3737

38-
######Useful options
38+
###### Useful options
3939
- `--regex` use regex to select particular scenarios to run.
4040

41-
#Stress tests (run_stress_tests.py)
41+
# Stress tests (run_stress_tests.py)
4242

4343
Runs modified interop tests clients and servers under heavy load for an extended period of time to discover potential stability issues.
4444
The tests are internally using Kubernetes to run the client and server on GKE and upload statistics to BigQuery.
@@ -47,10 +47,10 @@ The tests are internally using Kubernetes to run the client and server on GKE an
4747

4848
The directory `tools/run_tests/stress_test/configs/` contains the config files for several scenarios
4949

50-
#Artifacts & Packages (task_runner.py)
50+
# Artifacts & Packages (task_runner.py)
5151

5252
A generalized framework for running predefined tasks based on their labels. We use this to building binary artifacts & distrib packages and testing them)
5353

54-
######Example
54+
###### Example
5555
`tools/run_tests/task_runner.py -f python artifact linux x64` (build tasks with labels `python`, `artifact`, `linux`, and `x64`)
5656

vsprojects/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
#Pre-generated MS Visual Studio project & solution files
1+
# Pre-generated MS Visual Studio project & solution files
22

33
Versions 2013 and 2015 are both supported. You can use [their respective
44
community
55
editions](https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx).
66

7-
#Building
7+
# Building
88
We are using [NuGet](http://www.nuget.org) to pull zlib and openssl dependencies.
99
If you don't have Visual Studio NuGet plugin installed, you'll need to
1010
download nuget.exe from the web and manually restore the NuGet packages.
@@ -19,7 +19,7 @@ After that, you can build the solution using one of these options:
1919
1. open `grpc.sln` with Visual Studio and hit "Build".
2020
2. build from commandline using `msbuild grpc.sln /p:Configuration=Debug`
2121

22-
#C/C++ Test Dependencies
22+
# C/C++ Test Dependencies
2323
* gtest isn't available as a git repo like the other dependencies. download it and add it to `/third_party/gtest/` (the folder will end up with `/build-aux/`, `/cmake/`, `/codegear/`, etc. folders in it).
2424
* if using vs2013: open/import the gtest solution in `/msvc/`, and save over the first solution (you will have to change it from read-only). change all projects to use `/MDd` (Property Pages - C/C++ - Code Generation - Runtime Library) and build. This is a "multithreaded debug" setting and it needs to match grpc.
2525
* build all

0 commit comments

Comments
 (0)