Docs: Fix broken links

This fixes for all the broken links I found while working on googleforgames#367. Next PR to close googleforgames#367 will include automated testing of the documentation, just waiting to see if a bug fix I have in PR will flow through in a timely manner. If not, will install in our build image from my fork with the fixes.
markmandel · Nov 24, 2021 · 2618bca · 2618bca
1 parent 97a9fa0
commit 2618bca
Show file tree

Hide file tree

Showing 9 changed files with 16 additions and 15 deletions.
diff --git a/docs/src/faq.md b/docs/src/faq.md
@@ -10,8 +10,8 @@ change depending on the underlying hardware, number of filters, configurations a
 We highly recommend you run your own load tests on your platform and configuration, matching your production 
 workload and configuration as close as possible. 
 
-Our [iperf3](https://iperf.fr/) based performance test in the [examples' folder](../examples/iperf3) is a good 
-starting point.
+Our [iperf3](https://iperf.fr/) based performance test in the
+[examples' folder](https://github.com/googleforgames/quilkin/tree/main/examples/iperf3) is a good starting point.
 
 Since this is still an alpha project, we have plans on investigating further performance improvements in upcoming 
 releases, both from an optimisation and observability perspective as well.

diff --git a/docs/src/filters.md b/docs/src/filters.md
@@ -13,7 +13,9 @@ As an example, say we would like to perform the following steps in our processin
 * Compress the packet.
 * Do not forward (drop) the packet if its compressed length is over 512 bytes.
 
-We would create a filter corresponding to each step either by leveraging any [existing filters](#built-in-filters) that do what we want or [writing one ourselves](#writing-filters) and connect them to form the following filter chain:
+We would create a filter corresponding to each step either by leveraging any [existing filters](#built-in-filters)
+that do what we want or [writing one ourselves](./filters/writing_custom_filters.md) and connect them to form the 
+following filter chain:
 
 ```bash
 append | compress | drop
@@ -134,4 +136,4 @@ required: [ 'name', 'config' ]
 [TokenRouter]: ./filters/token_router.md
 [Debug]: ./filters/debug.md
 [LocalRateLimit]: ./filters/local_rate_limit.md
-[`quilkin::metadata::Value`]: https://docs.rs/quilkin/metadata/enum.Value.html
+[`quilkin::metadata::Value`]: ../api/quilkin/metadata/enum.Value.html
diff --git a/docs/src/filters/capture_bytes.md b/docs/src/filters/capture_bytes.md
@@ -69,5 +69,4 @@ properties:
   A counter of the total number of packets that have been dropped due to their length being less than the configured
   `size`.
 
-
-[filter-dynamic-metadata]: ./filter.md#filter-dynamic-metadata
+[filter-dynamic-metadata]: ../filters.md#filter-dynamic-metadata
diff --git a/docs/src/filters/compress.md b/docs/src/filters/compress.md
@@ -32,7 +32,7 @@ sent to the local listening port and then compressed when heading up to a dedica
 decompressed when traffic is returned from the dedicated game server before being handed back to game client. 
 
 > It is worth noting that since the Compress filter modifies the *entire packet*, it is worth paying special
-  attention to the order it is placed in your [Filter configuration](filters.md). Most of the time it will likely be
+  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 ([Rust Doc](../../api/quilkin/filters/compress/struct.Config.html))

diff --git a/docs/src/filters/token_router.md b/docs/src/filters/token_router.md
@@ -108,5 +108,5 @@ static:
 On the game client side the [ConcatenateBytes](./concatenate_bytes.md) filter could also be used to add authentication
 tokens to outgoing packets.
 
-[filter-dynamic-metadata]: ./filters.md#filter-dynamic-metadata
-[endpoint-tokens]: ../../proxy.md#upstream-endpoint
+[filter-dynamic-metadata]: ../filters.md#filter-dynamic-metadata
+[endpoint-tokens]: ../proxy.md#upstream-endpoint
diff --git a/docs/src/proxy.md b/docs/src/proxy.md
@@ -58,9 +58,9 @@ The proxy exposes the following general metrics (See the metrics sub-sections fo
 
 [sessions-doc]: ./session.md
 [session-metrics]: ./session.md#metrics
-[filters-doc]: ./extensions/filters/filters.md
+[filters-doc]: ./filters.md
 [endpoint]: #upstream-endpoint
 [proxy-configuration]: ./proxy-configuration.md
 [xds-endpoint-metadata]: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/endpoint/v3/endpoint_components.proto#envoy-v3-api-field-config-endpoint-v3-lbendpoint-metadata
 [dynamic-configuration-doc]: ./xds.md
-[TokenRouter]: ./extensions/filters/token_router.md
+[TokenRouter]: ./filters/token_router.md
diff --git a/docs/src/quickstart-agones-xonotic.md b/docs/src/quickstart-agones-xonotic.md
@@ -82,7 +82,7 @@ Run the following:
 kubectl apply -f https://raw.githubusercontent.com/googleforgames/quilkin/main/examples/agones-xonotic/sidecar-compress.yaml
 ```
 
-This will implement the [Compress](./extensions/filters/compress.md) filter in our Quilkin sidecar proxy in our new 
+This will implement the [Compress](./filters/compress.md) filter in our Quilkin sidecar proxy in our new 
 Fleet.
 
 Now you can run `kubectl get gameservers` until all your Agones `GameServers` are marked as `Ready` like so:
@@ -133,4 +133,4 @@ kubectl delete -f https://raw.githubusercontent.com/googleforgames/quilkin/main/
 ## What's Next?
 
 * Have a look at the [examples](https://github.com/googleforgames/quilkin/blob/main/examples) folder for configuration and usage examples.
-* Explore the [proxy configuration reference](./docs/proxy-configuration.md) for other configuration options. 
+* Explore the [proxy configuration reference](./proxy-configuration.md) for other configuration options. 
diff --git a/docs/src/using.md b/docs/src/using.md
@@ -38,7 +38,7 @@ Whereas, if you need debugging logging, use the following tag:
 Mount your [configuration file](./proxy-configuration.md) at `/etc/quilkin/quilkin.yaml` to configure the Quilkin 
 instance inside the container.
 
-A [default configuration](https://github.com/googleforgames/quilkin/blob/examples/agones-sidecar/build/release/quilkin.yaml)
+A [default configuration](https://github.com/googleforgames/quilkin/blob/main/image/quilkin.yaml)
 is provided, such the container will start without a new configuration file, but it is configured to point to 
 `127.0.0.1:0` as a no-op configuration.
 

diff --git a/src/metadata.rs b/src/metadata.rs
@@ -18,7 +18,7 @@ use std::{collections::HashMap, convert::TryFrom, sync::Arc};
 
 use crate::xds::envoy::config::core::v3::Metadata as ProtoMetadata;
 
-/// Shared state between [`Filter`]s during processing for a single packet.
+/// Shared state between [`Filter`][crate::filters::Filter]s during processing for a single packet.
 pub type DynamicMetadata = HashMap<Arc<String>, Value>;
 
 pub const KEY: &str = "quilkin.dev";