docs: add links to router tech notes (#4399)

apollographql · Jan 4, 2024 · 70f2ae3 · 70f2ae3
1 parent 77059f6
commit 70f2ae3
Show file tree

Hide file tree

Showing 8 changed files with 31 additions and 2 deletions.
diff --git a/docs/source/configuration/authorization.mdx b/docs/source/configuration/authorization.mdx
@@ -912,3 +912,7 @@ authorization:
     enabled: true
     dry_run: true # default: false
 ```
+
+## Related topics
+
+* [Authenticating requests with the Apollo Router](/technotes/TN0004-router-authentication/)
diff --git a/docs/source/configuration/overview.mdx b/docs/source/configuration/overview.mdx
@@ -882,3 +882,7 @@ You can also view a diff of exactly which changes are necessary to upgrade your
 ```bash
 ./router config upgrade --diff <path_to_config.yaml>
 ```
+
+## Related topics
+
+* [Checklist for configuring the router for production](/technotes/TN0008-production-readiness-checklist/#apollo-router)
diff --git a/docs/source/configuration/telemetry/exporters/metrics/overview.mdx b/docs/source/configuration/telemetry/exporters/metrics/overview.mdx
@@ -193,3 +193,7 @@ OpenTelemetry includes many [standard attributes](https://opentelemetry.io/docs/
 | `attributes`        |                          | Customization for the apollo_router_http_requests instrument. |
 
 
+## Related topics
+
+* [Connecting OpenTelemetry traces to Prometheus](/technotes/TN0003-opentelemetry-traces-to-prometheus)
+* [Sending Apollo Router traces and metrics to APM tools using OpenTelemetry](/technotes/TN0015-router-to-apm-via-opentelemetry/)
diff --git a/docs/source/configuration/telemetry/exporters/tracing/overview.mdx b/docs/source/configuration/telemetry/exporters/tracing/overview.mdx
@@ -224,6 +224,7 @@ Using this configuration you will have a response header called `my-trace-id` co
 | `max_events_per_span`            | 128                      | The maximum number of events per span.          |
 | `max_links_per_span`             | 128                      | The maximum links per span.                     |
 
+## Related topics
 
-
-
+* [Connecting OpenTelemetry traces to Prometheus](/technotes/TN0003-opentelemetry-traces-to-prometheus)
+* [Sending Apollo Router traces and metrics to APM tools using OpenTelemetry](/technotes/TN0015-router-to-apm-via-opentelemetry/)
diff --git a/docs/source/containerization/kubernetes.mdx b/docs/source/containerization/kubernetes.mdx
@@ -102,6 +102,15 @@ Install the tools and provision the infrastructure for your Kubernetes cluster.
 
 For an example, see the [Setup from Apollo's Build a Supergraph tutorial](https://github.com/apollosolutions/build-a-supergraph/tree/main/01-setup#01---setup). It provides steps you can reference for gathering accounts and credentials for your cloud platform (GCP or AWS), provisioning resources, and deploying your subgraphs.
 
+<Tip>
+
+To manage the system resources you need to deploy the router on Kubernetes:
+
+* Read [Managing Apollo Router resources in Kubernetes](/technotes/TN0016-router-resource-management/).
+* Use the [router resource estimator](/technotes/TN0045-router_resource_estimator/).
+
+</Tip>
+
 ### Set up graph
 
 Set up your self-hosted graph and get its [graph ref](../configuration/overview/#apollo_graph_ref) and [API key](../configuration/overview/#apollo_graph_ref).

diff --git a/docs/source/customizations/custom-binary.mdx b/docs/source/customizations/custom-binary.mdx
@@ -207,3 +207,7 @@ COPY my_supergraph.graphql /dist/supergraph.graphql
 # Default executable is the router
 ENTRYPOINT ["/dist/router", "-s", "/dist/supergraph.graphql"]
 ```
+
+## Related topics
+
+* [Optimizing Custom Apollo Router Builds](/technotes/TN0030-optimizing-router-builds/)
diff --git a/docs/source/index.mdx b/docs/source/index.mdx
@@ -22,6 +22,8 @@ flowchart LR;
 
 The Apollo Router intelligently distributes inbound queries across your GraphQL-powered microservices, enabling clients to fetch data from multiple sources with a single request.
 
+> Learn about the [distinction between the Apollo Router and API gateways](/technotes/TN0037-api-gateways/).
+
 If you have an existing federated graph that currently uses `@apollo/gateway`, you can move to the Apollo Router without changing any other part of your graph.
 
 <p>

diff --git a/docs/source/quickstart.mdx b/docs/source/quickstart.mdx
@@ -215,3 +215,4 @@ Now that you know how to run the Apollo Router with a supergraph schema, you can
 
 * Set up [managed federation](/federation/managed-federation/overview)
 * Learn about [additional configuration options](./configuration/overview)
+* [Estimate the system resources needed to deploy the router](/technotes/TN0045-router_resource_estimator/).
-Original file line number
+Diff line change
@@ Expand Up / @@ -22,6 +22,8 @@ flowchart LR; @@
     The Apollo Router intelligently distributes inbound queries across your GraphQL-powered microservices, enabling clients to fetch data from multiple sources with a single request.
+    > Learn about the [distinction between the Apollo Router and API gateways](/technotes/TN0037-api-gateways/).
     If you have an existing federated graph that currently uses `@apollo/gateway`, you can move to the Apollo Router without changing any other part of your graph.
     <p>
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -215,3 +215,4 @@ Now that you know how to run the Apollo Router with a supergraph schema, you can

		* Set up [managed federation](/federation/managed-federation/overview)
		* Learn about [additional configuration options](./configuration/overview)
		* [Estimate the system resources needed to deploy the router](/technotes/TN0045-router_resource_estimator/).