Skip to content

Commit a7d4065

Browse files
authored
chore: Adjust READMEs (#33)
* envoy-proto-collect: adjust `README` formatting * examples: adjust `README` Format, use inline links, add 'Quick Templates' section.
1 parent 5dd617a commit a7d4065

File tree

2 files changed

+22
-20
lines changed

2 files changed

+22
-20
lines changed

envoy-proto-collect/README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,27 @@
11
# Envoy Proto Collect
22

3-
This crate is a tool used to collect selected proto files from the repos
4-
contained in the `submodules` directory, adding said files to the repo's
5-
`envoy-types/proto` directory.
3+
This crate is a tool used to collect selected proto files from the repos contained in the
4+
`submodules` directory, adding said files to the repo's `envoy-types/proto` directory.
65

7-
Besides that, `Apache-2.0` declarations are added to the top of the proto files
8-
lacking them.
6+
Besides that, `Apache-2.0` declarations are added to the top of the proto files lacking them.
97

108
## Run the Proto Collection Tool
119

12-
First, delete the contents of the repo's `envoy-types/proto` directory, to
13-
ensure that only the protos that were just collected are present in the
14-
directory by the end of the process.
10+
First, delete the contents of the repo's `envoy-types/proto` directory, to ensure that only the
11+
protos that were just collected are present in the directory by the end of the process.
1512

1613
Then, run the tool:
1714

1815
```bash
1916
$ cargo run --bin collect-protos
2017
```
2118

22-
The compilation of the protos can be achieved by running the `bootstrap` test
23-
of the `envoy-types` crate. This can be done by simply running:
19+
The compilation of the protos can be achieved by running the `bootstrap` test of the `envoy-types`
20+
crate. This can be done by simply running:
2421

2522
```bash
2623
$ cargo test bootstrap
2724
```
2825

29-
On the repo's root directory. If `git` detects any changes in the resulting
30-
generated files, the test will fail.
26+
On the repo's root directory. If `git` detects any changes in the resulting generated files, the
27+
test will fail.

examples/README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
11
# Examples
22

3+
## Quick Templates
4+
5+
Direct source code links for quick reference:
6+
7+
| Category | Raw Source |
8+
|----------|------------|
9+
| **ExtAuthz Server Basic** | [authorization_server_basic.rs](https://raw.githubusercontent.com/flemosr/envoy-types/refs/heads/main/examples/src/ext_authz/authorization_server_basic.rs) |
10+
| **ExtAuthz Server Full** | [authorization_server_full.rs](https://raw.githubusercontent.com/flemosr/envoy-types/refs/heads/main/examples/src/ext_authz/authorization_server_full.rs) |
11+
| **ExtAuthz Server PB Only** | [authorization_server_pb_only.rs](https://raw.githubusercontent.com/flemosr/envoy-types/refs/heads/main/examples/src/ext_authz/authorization_server_pb_only.rs) |
12+
313
## Envoy's ExtAuthz gRPC Authorization Server
414

515
There are three examples showing how to implement an
6-
[Envoy External Authorization] gRPC Server written in Rust, with [`tonic`].
7-
8-
[Envoy External Authorization]: https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/ext_authz_filter
16+
[Envoy External Authorization](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/ext_authz_filter)
17+
gRPC Server written in Rust, with [`tonic`](https://github.com/hyperium/tonic).
918

1019
A bare-bones implementation:
1120

@@ -27,9 +36,5 @@ $ cargo run --example authorization-server-pb-only
2736
```
2837

2938
For more complete examples, including the connection to an actual `envoy`
30-
container, check the [envoy-extauthz-rust] and [envoy-extauthz-rust-rate-limit]
39+
container, check the [envoy-extauthz-rust](https://github.com/flemosr/envoy-extauthz-rust) and [envoy-extauthz-rust-rate-limit](https://github.com/flemosr/envoy-extauthz-rust-rate-limit)
3140
repositories.
32-
33-
[envoy-extauthz-rust]: https://github.com/flemosr/envoy-extauthz-rust
34-
[envoy-extauthz-rust-rate-limit]: https://github.com/flemosr/envoy-extauthz-rust-rate-limit
35-
[`tonic`]: https://github.com/hyperium/tonic

0 commit comments

Comments
 (0)