Skip to content

Commit

Permalink
Add "Rust Doc" link to each Filter (#434)
Browse files Browse the repository at this point in the history
In #432 we introduced having the documentation for a Filter have a
openapi spec description, as well as a link to the Rust doc definition
of its configuration.

I liked it so much, I went and did it for the rest of the filters.
  • Loading branch information
markmandel authored Nov 8, 2021
1 parent a04c9d1 commit 5e35f70
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/src/filters/capture_bytes.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ static:
# quilkin::Builder::from(std::sync::Arc::new(config)).validate().unwrap();
```

### Configuration Options
### Configuration Options ([Rust Doc](../../api/quilkin/filters/capture_bytes/struct.Config.html))

```yaml
properties:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/filters/compress.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ decompressed when traffic is returned from the dedicated game server before bein
attention to the order it is placed in your [Filter configuration](filters.md). Most of the time it will likely be
the first or last Filter configured to ensure it is compressing the entire set of data being sent.

### Configuration Options
### Configuration Options ([Rust Doc](../../api/quilkin/filters/compress/struct.Config.html))

```yaml
properties:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/filters/concatenate_bytes.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ static:
# quilkin::Builder::from(std::sync::Arc::new(config)).validate().unwrap();
```

### Configuration Options
### Configuration Options ([Rust Doc](../../api/quilkin/filters/concatenate_bytes/struct.Config.html))

```yaml
properties:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/filters/debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ static:
# quilkin::Builder::from(std::sync::Arc::new(config)).validate().unwrap();
```

### Configuration Options
### Configuration Options ([Rust Doc](../../api/quilkin/filters/debug/struct.Config.html))

```yaml
properties:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/filters/load_balancer.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ static:
The load balancing policy (the strategy to use to select what endpoint to send traffic to) is configurable.
In the example above, packets will be distributed by selecting endpoints in turn, in round robin fashion.

### Configuration Options
### Configuration Options ([Rust Doc](../../api/quilkin/filters/load_balancer/struct.Config.html))

```yaml
properties:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/filters/local_rate_limit.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ To configure a rate limiter, we specify the maximum rate at which the proxy is a
> Packets that that exceeds the maximum configured rate are dropped.
### Configuration Options
### Configuration Options ([Rust Doc](../../api/quilkin/filters/local_rate_limit/struct.Config.html))

```yaml
properties:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/filters/token_router.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ static:

View the [CaptureBytes](./capture_bytes.md) filter documentation for more details.

### Configuration Options
### Configuration Options ([Rust Doc](../../api/quilkin/filters/token_router/struct.Config.html))

```yaml
properties:
Expand Down

0 comments on commit 5e35f70

Please sign in to comment.