diff --git a/docs/shared/register-federated-cli.mdx b/docs/shared/register-federated-cli.mdx index c74b6492a7..a8ad0cdb93 100644 --- a/docs/shared/register-federated-cli.mdx +++ b/docs/shared/register-federated-cli.mdx @@ -17,7 +17,7 @@ graph LR; If you haven't yet: * Install the Rover CLI. -* Authenticate Rover with Apollo Studio. +* Authenticate Rover with GraphOS Studio. Then, **do the following for each of your subgraphs**: @@ -38,4 +38,4 @@ Then, **do the following for each of your subgraphs**: As you register your subgraph schemas, the schema registry attempts to **compose** their latest versions into a single **supergraph schema**. Whenever composition succeeds, the Apollo Router can fetch the latest supergraph schema from the registry. -You can also manually fetch your latest supergraph schema with the `rover supergraph fetch` command, or retrieve it from your graph's **Schema > SDL** tab in Apollo Studio. +You can also manually fetch your latest supergraph schema with the `rover supergraph fetch` command, or retrieve it from your graph's **Schema > SDL** tab in GraphOS Studio. diff --git a/docs/source/config.json b/docs/source/config.json index 282830e788..e176c00d83 100644 --- a/docs/source/config.json +++ b/docs/source/config.json @@ -7,8 +7,8 @@ "Introduction": "/", "Quickstart": "/quickstart", "Moving from @apollo/gateway": "/migrating-from-gateway", - "Federation version support": "/federation-version-support", - "Enterprise features": [ + "Federation Version Support": "/federation-version-support", + "Enterprise Features": [ "/enterprise-features", [ "enterprise" @@ -17,14 +17,14 @@ "Configuring the Router": { "Overview": "/configuration/overview", "Caching": { - "In-memory caching": "/configuration/in-memory-caching", - "Distributed caching": [ + "In-Memory Caching": "/configuration/in-memory-caching", + "Distributed Caching": [ "/configuration/distributed-caching", [ "enterprise" ] ], - "Entity caching": [ + "Entity Caching": [ "/configuration/entity-caching", [ "enterprise", @@ -35,15 +35,15 @@ "Debugging": { "Errors": "/errors", "Telemetry": "/configuration/telemetry/overview", - "Subgraph error inclusion": "/configuration/subgraph-error-inclusion" + "Subgraph Error Inclusion": "/configuration/subgraph-error-inclusion" }, "Networking": { - "Header propagation": "/configuration/header-propagation", - "Traffic shaping": "/configuration/traffic-shaping" + "Header Propagation": "/configuration/header-propagation", + "Traffic Shaping": "/configuration/traffic-shaping" }, "Security": { "CORS": "/configuration/cors", - "CSRF prevention": "/configuration/csrf", + "CSRF Prevention": "/configuration/csrf", "JWT Authentication": [ "/configuration/authn-jwt", [ @@ -57,46 +57,46 @@ ] ], "Subgraph Authentication": "/configuration/authn-subgraph", - "Operation limits": [ + "Operation Limits": [ "/configuration/operation-limits", [ "enterprise" ] ], - "Safelisting with persisted queries": [ + "Safelisting with Persisted Queries": [ "/configuration/persisted-queries", [ "enterprise" ] ], - "Privacy and data collection": "/privacy" + "Privacy and Data Collection": "/privacy" } }, "Executing Operations": { - "Build and run queries": "/executing-operations/build-run-queries", - "@defer support": "/executing-operations/defer-support", - "Request format": "/executing-operations/requests", - "Query batching": [ + "Build and Run Queries": "/executing-operations/build-run-queries", + "@defer Support": "/executing-operations/defer-support", + "Request Format": "/executing-operations/requests", + "Query Batching": [ "/executing-operations/query-batching", [ "enterprise" ] ], "GraphQL Subscriptions": { - "Subscriptions setup": [ + "Subscriptions Setup": [ "/executing-operations/subscription-support", [ "enterprise" ] ], - "Subgraph protocol: HTTP callback": [ + "Subgraph Protocol: HTTP Callback": [ "/executing-operations/subscription-callback-protocol", [ "enterprise", "preview" ] ], - "Client protocol: HTTP multipart": [ + "Client Protocol: HTTP Multipart": [ "/executing-operations/subscription-multipart-protocol", [ "enterprise" @@ -106,13 +106,13 @@ }, "Telemetry and Monitoring": { "Overview": "/configuration/telemetry/overview", - "GraphOS reporting": "/configuration/telemetry/apollo-telemetry", - "Client awareness": "/managed-federation/client-awareness", - "Log exporters": { + "GraphOS Reporting": "/configuration/telemetry/apollo-telemetry", + "Client Awareness": "/managed-federation/client-awareness", + "Log Exporters": { "Configuration": "/configuration/telemetry/exporters/logging/overview", "Stdout": "/configuration/telemetry/exporters/logging/stdout" }, - "Metrics exporters": { + "Metrics Exporters": { "Configuration": "/configuration/telemetry/exporters/metrics/overview", "Datadog": "/configuration/telemetry/exporters/metrics/datadog", "New Relic": "/configuration/telemetry/exporters/metrics/new-relic", @@ -133,37 +133,37 @@ "Conditions": "/configuration/telemetry/instrumentation/conditions", "Spans": "/configuration/telemetry/instrumentation/spans", "Selectors": "/configuration/telemetry/instrumentation/selectors", - "Standard attributes": "/configuration/telemetry/instrumentation/standard-attributes", - "Standard instruments": "/configuration/telemetry/instrumentation/standard-instruments" + "Standard Attributes": "/configuration/telemetry/instrumentation/standard-attributes", + "Standard Instruments": "/configuration/telemetry/instrumentation/standard-instruments" } }, "Containerization": { "Overview": "/containerization/overview", "Deploy on Kubernetes": "/containerization/kubernetes", "Run with Docker": "/containerization/docker", - "Health checks": "/configuration/health-checks" + "Health Checks": "/configuration/health-checks" }, "Managed Federation": { "Overview": "https://www.apollographql.com/docs/federation/managed-federation/overview", "Setup": "https://www.apollographql.com/docs/federation/managed-federation/setup", - "GraphOS Studio features": "https://www.apollographql.com/docs/graphos/graphs/federated-graphs" + "GraphOS Studio Features": "https://www.apollographql.com/docs/graphos/graphs/federated-graphs" }, "Customizations": { "Overview": "/customizations/overview", - "Rhai scripts": "/customizations/rhai", - "Rhai API reference": "/customizations/rhai-api", - "External coprocessing": [ + "Rhai Scripts": "/customizations/rhai", + "Rhai API Reference": "/customizations/rhai-api", + "External Coprocessing": [ "/customizations/coprocessor", [ "enterprise" ] ], - "Native Rust plugins": "/customizations/native", - "Custom router binary": "/customizations/custom-binary" + "Native Rust Plugins": "/customizations/native", + "Custom Router Binary": "/customizations/custom-binary" }, "Subgraph Support": { - "Subgraph-compatible libraries": "https://www.apollographql.com/docs/federation/v2/other-servers/", - "Subgraph specification": "https://www.apollographql.com/docs/federation/v2/federation-spec/" + "Subgraph-Compatible Libraries": "https://www.apollographql.com/docs/federation/v2/other-servers/", + "Subgraph Specification": "https://www.apollographql.com/docs/federation/v2/federation-spec/" } } } diff --git a/docs/source/configuration/authn-jwt.mdx b/docs/source/configuration/authn-jwt.mdx index f99c6e489b..3affa08fa9 100644 --- a/docs/source/configuration/authn-jwt.mdx +++ b/docs/source/configuration/authn-jwt.mdx @@ -1,6 +1,7 @@ --- title: JWT Authentication in the Apollo Router -description: Restrict access to credentialed users and systems +subtitle: Restrict access to credentialed users and systems +description: Protect sensitive data by enabling JWT authentication in the Apollo Router. Restrict access to credentialed users and systems. --- diff --git a/docs/source/configuration/authn-subgraph.mdx b/docs/source/configuration/authn-subgraph.mdx index 771af8ac1e..c9f1a3c378 100644 --- a/docs/source/configuration/authn-subgraph.mdx +++ b/docs/source/configuration/authn-subgraph.mdx @@ -1,5 +1,7 @@ --- title: Subgraph Authentication in the Apollo Router +subtitle: Implement subgraph authentication using AWS SigV4 +description: Secure communication to AWS subgraphs via the Apollo Router using AWS Signature Version 4 (SigV4). minVersion: 1.27.0 --- diff --git a/docs/source/configuration/authorization.mdx b/docs/source/configuration/authorization.mdx index e1e845ad14..3566babead 100644 --- a/docs/source/configuration/authorization.mdx +++ b/docs/source/configuration/authorization.mdx @@ -1,6 +1,7 @@ --- title: Authorization in the Apollo Router -description: Strengthen service security with a centralized governance layer +subtitle: Strengthen subgraph security with a centralized governance layer +description: Enforce authorization in the Apollo Router with the @requireScopes, @authenticated, and @policy directives. --- diff --git a/docs/source/configuration/cors.mdx b/docs/source/configuration/cors.mdx index 71ac87fd28..43ac8f20ee 100644 --- a/docs/source/configuration/cors.mdx +++ b/docs/source/configuration/cors.mdx @@ -1,7 +1,7 @@ --- title: Configuring CORS in the Apollo Router -sidebar_title: CORS -description: Control browser access to your router +subtitle: Control browser access to your router +description: Manage browser access to your Apollo Router with CORS configuration options, including origin whitelisting, wildcard origins, and credential passing. --- @@ -13,7 +13,7 @@ description: Control browser access to your router -By default, the Apollo Router enables _only_ Apollo Studio to initiate browser connections to it. If your supergraph serves data to other browser-based applications, you need to do one of the following in the `cors` section of your router's [YAML config file](./overview/#yaml-config-file): +By default, the Apollo Router enables _only_ GraphOS Studio to initiate browser connections to it. If your supergraph serves data to other browser-based applications, you need to do one of the following in the `cors` section of your router's [YAML config file](./overview/#yaml-config-file): * Add the origins of those web applications to the router's list of allowed `origins`. * Use this option if there is a known, finite list of web applications that consume your supergraph. @@ -36,13 +36,13 @@ cors: # List of accepted origins # (Ignored if allow_any_origin is true) - # (Defaults to the Apollo Studio url: `https://studio.apollographql.com`) + # (Defaults to the GraphOS Studio url: `https://studio.apollographql.com`) # # An origin is a combination of scheme, hostname and port. # It does not have any path section, so no trailing slash. origins: - https://www.your-app.example.com - - https://studio.apollographql.com # Keep this so Apollo Studio can run queries against your router + - https://studio.apollographql.com # Keep this so GraphOS Studio can run queries against your router match_origins: - "^https://([a-z0-9]+[.])*api[.]example[.]com$" # any host that uses https and ends with .api.example.com ``` @@ -110,7 +110,7 @@ cors: # An origin is a combination of scheme, hostname and port. # It does not have any path section, so no trailing slash. origins: - - https://studio.apollographql.com # Keep this so Apollo Studio can still run queries against your router + - https://studio.apollographql.com # Keep this so GraphOS Studio can still run queries against your router # Set to true to add the `Access-Control-Allow-Credentials` header allow_credentials: false diff --git a/docs/source/configuration/csrf.mdx b/docs/source/configuration/csrf.mdx index 8a05e3e3bf..4a9860e781 100644 --- a/docs/source/configuration/csrf.mdx +++ b/docs/source/configuration/csrf.mdx @@ -1,6 +1,5 @@ --- title: Cross-Site Request Forgery (CSRF) Prevention -sidebar_title: CSRF prevention subtitle: Prevent CSRF attacks in the Apollo Router description: Prevent cross-site request forgery (CSRF) attacks in the Apollo Router. minVersion: 0.9.0 diff --git a/docs/source/configuration/distributed-caching.mdx b/docs/source/configuration/distributed-caching.mdx index cc2b64ee57..3938f832e7 100644 --- a/docs/source/configuration/distributed-caching.mdx +++ b/docs/source/configuration/distributed-caching.mdx @@ -1,6 +1,6 @@ --- -title: Distributed caching for the Apollo Router -subtitle: Redis-backed caching for query plans and APQ +title: Distributed Caching for the Apollo Router +subtitle: Configure Redis-backed caching for query plans and APQ description: Distributed caching for Apollo Router with GraphOS Enterprise. Configure a Redis-backed cache for query plans and automatic persisted queries (APQ). --- diff --git a/docs/source/configuration/entity-caching.mdx b/docs/source/configuration/entity-caching.mdx index 1122ada2ae..20f83a5529 100644 --- a/docs/source/configuration/entity-caching.mdx +++ b/docs/source/configuration/entity-caching.mdx @@ -1,6 +1,6 @@ --- -title: Subgraph entity caching for the Apollo Router -subtitle: Redis-backed caching for entities +title: Subgraph Entity Caching for the Apollo Router +subtitle: Configure Redis-backed caching for entities description: Subgraph entity caching for Apollo Router with GraphOS Enterprise. Cache and reuse individual entities across queries. minVersion: 1.40.0 --- diff --git a/docs/source/configuration/header-propagation.mdx b/docs/source/configuration/header-propagation.mdx index 7078e36afa..2dfc151548 100644 --- a/docs/source/configuration/header-propagation.mdx +++ b/docs/source/configuration/header-propagation.mdx @@ -1,6 +1,7 @@ --- -title: Sending HTTP headers to subgraphs -description: Configure which headers the Apollo Router sends to which subgraphs +title: Header Propogation +subtitle: Configure HTTP header propagation to subgraphs +description: Configure which HTTP headers the Apollo Router sends to which subgraphs. Define per-subgraph header rules, along with rules that apply to all subgraphs. --- You can configure which HTTP headers the Apollo Router includes in its requests to each of your subgraphs. You can define per-subgraph header rules, along with rules that apply to _all_ subgraphs. diff --git a/docs/source/configuration/health-checks.mdx b/docs/source/configuration/health-checks.mdx index 0ef40f1a8b..8d0bfd3dba 100644 --- a/docs/source/configuration/health-checks.mdx +++ b/docs/source/configuration/health-checks.mdx @@ -1,6 +1,7 @@ --- -title: Health checks in the Apollo Router -description: Determining the router's status +title: Health Checks in the Apollo Router +subtitle: Determining the router's status +description: Learn how to run health checks to determine whether an Apollo Router is available and ready to start serving traffic. --- Health checks are often used by load balancers to determine whether a server is available and ready to start serving traffic. diff --git a/docs/source/configuration/in-memory-caching.mdx b/docs/source/configuration/in-memory-caching.mdx index ccbb10ec3d..4e483906a6 100644 --- a/docs/source/configuration/in-memory-caching.mdx +++ b/docs/source/configuration/in-memory-caching.mdx @@ -1,5 +1,7 @@ --- -title: In-memory caching in the Apollo Router +title: In-Memory Caching in the Apollo Router +subtitle: Configure caching for query plans and automatic persisted queries +description: Configure the Apollo Router's in-memory caching for improved performance. Configure query plans and automatic persisted queries caching. --- The Apollo Router uses an in-memory LRU cache to store the following data: @@ -17,6 +19,7 @@ If you have a GraphOS Enterprise plan, you can also configure a Redis-backed _di ## Performance improvements vs stability + The Router is a highly scalable and low-latency runtime. Even with all caching **disabled**, the time to process operations and query plans will be very minimal (nanoseconds to milliseconds) when compared to the overall supergraph request, except in the edge cases of extremely large operations and supergraphs. Caching offers stability to those running a large graph so that your overhead for given operations stays consistent, not that it dramatically improves. If you would like to validate the performance wins of operation caching, check out the [traces and metrics in the Router](/router/configuration/telemetry/instrumentation/standard-instruments#performance) to take measurements before and after. In extremely large edge cases though, we have seen the cache save 2-10x time to create the query plan, which is still a small part of the overall request. ## Caching query plans diff --git a/docs/source/configuration/operation-limits.mdx b/docs/source/configuration/operation-limits.mdx index 4641fe1ba0..d94a578485 100644 --- a/docs/source/configuration/operation-limits.mdx +++ b/docs/source/configuration/operation-limits.mdx @@ -1,6 +1,7 @@ --- -title: Enforcing operation limits in the Apollo Router -description: With GraphOS Enterprise +title: Enforcing Operation Limits in the Apollo Router +subtitle: Set constraints on depth, height, aliases, and root fields +description: Ensure your GraphQL operations are secure with Apollo Router's operation limits. Set constraints on depth, height, aliases, and root fields. --- diff --git a/docs/source/configuration/overview.mdx b/docs/source/configuration/overview.mdx index 2d2af0e37a..f70fcaea1b 100644 --- a/docs/source/configuration/overview.mdx +++ b/docs/source/configuration/overview.mdx @@ -1,6 +1,7 @@ --- title: Configuring the Apollo Router -description: Command arguments and YAML config +subtitle: With environment variables, command-line options, and YAML file configuration +description: Learn how to configure the Apollo Router with environment variables, command-line options and commands, and YAML configuration files. --- import RedisTLS from '../../shared/redis-tls.mdx' diff --git a/docs/source/configuration/persisted-queries.mdx b/docs/source/configuration/persisted-queries.mdx index 2566ffbbc2..ae7c098370 100644 --- a/docs/source/configuration/persisted-queries.mdx +++ b/docs/source/configuration/persisted-queries.mdx @@ -1,6 +1,7 @@ --- -title: Safelisting with persisted queries -description: Secure your graph while minimizing request latency +title: Safelisting with Persisted Queries +subtitle: Secure your graph while minimizing request latency +description: Secure your federated GraphQL API by creating an allowlist of trusted operations. Minimize request latency and enhance performance. minVersion: 1.25.0 --- diff --git a/docs/source/configuration/subgraph-error-inclusion.mdx b/docs/source/configuration/subgraph-error-inclusion.mdx index 72154feeee..a5a13c77ec 100644 --- a/docs/source/configuration/subgraph-error-inclusion.mdx +++ b/docs/source/configuration/subgraph-error-inclusion.mdx @@ -1,5 +1,7 @@ --- -title: Subgraph error inclusion +title: Subgraph Error Inclusion +subtitle: Configure the router to propagate subgraph errors to clients +description: Configure the Apollo Router to propagate subgraph errors to clients for all subgraphs or on a per-subgraph basis. --- By default, the Apollo Router redacts the details of subgraph errors in its responses to clients. The router instead returns a default error with the following message: diff --git a/docs/source/configuration/telemetry/apollo-telemetry.mdx b/docs/source/configuration/telemetry/apollo-telemetry.mdx index e77a17b7dc..847aa23cd4 100644 --- a/docs/source/configuration/telemetry/apollo-telemetry.mdx +++ b/docs/source/configuration/telemetry/apollo-telemetry.mdx @@ -1,7 +1,7 @@ --- title: GraphOS reporting subtitle: Send Apollo Router operation metrics to GraphOS -description: Report operation usage metrics from the Apollo Router to GraphOS to enable schema checks and metrics visualization in GraphOS Studio +description: Report GraphQL operation usage metrics from the Apollo Router to GraphOS to enable schema checks and metrics visualization in GraphOS Studio. --- The Apollo Router can report operation usage metrics to [GraphOS](/graphos/) that you can then visualize in GraphOS Studio. These metrics also enable powerful GraphOS features like [schema checks](/graphos/delivery/schema-checks/). @@ -280,17 +280,17 @@ An array of names for the variables that the router _will not_ report to GraphOS ```yaml title="router.yaml" telemetry: apollo: - # The percentage of requests will include HTTP request and response headers in traces sent to Apollo Studio. + # The percentage of requests will include HTTP request and response headers in traces sent to GraphOS Studio. # This is expensive and should be left at a low value. # This cannot be higher than tracing->common->sampler field_level_instrumentation_sampler: 0.01 # (default) - # Include HTTP request and response headers in traces sent to Apollo Studio + # Include HTTP request and response headers in traces sent to GraphOS Studio send_headers: # other possible values are all, only (with an array), except (with an array), none (by default) except: # Send all headers except referer - referer - # Include variable values in Apollo in traces sent to Apollo Studio + # Include variable values in Apollo in traces sent to GraphOS Studio send_variable_values: # other possible values are all, only (with an array), except (with an array), none (by default) except: # Send all variable values except for variable named first - first diff --git a/docs/source/configuration/telemetry/exporters/metrics/datadog.mdx b/docs/source/configuration/telemetry/exporters/metrics/datadog.mdx index cda1177868..bcf4ddb6ea 100644 --- a/docs/source/configuration/telemetry/exporters/metrics/datadog.mdx +++ b/docs/source/configuration/telemetry/exporters/metrics/datadog.mdx @@ -1,7 +1,7 @@ --- title: Datadog exporter (via OTLP) subtitle: Configure the Datadog exporter for metrics -description: Configure the Datadog exporter for metrics via OpenTelemetry Protocol (OTLP) in the Apollo Router +description: Configure the Datadog exporter for metrics via OpenTelemetry Protocol (OTLP) in the Apollo Router. --- Enable and configure the [OTLP exporter](./otlp) for metrics in the Apollo Router for use with [Datadog](https://www.datadoghq.com/). diff --git a/docs/source/configuration/telemetry/exporters/metrics/new-relic.mdx b/docs/source/configuration/telemetry/exporters/metrics/new-relic.mdx index 2767f5d4f8..13402a1ed8 100644 --- a/docs/source/configuration/telemetry/exporters/metrics/new-relic.mdx +++ b/docs/source/configuration/telemetry/exporters/metrics/new-relic.mdx @@ -1,7 +1,7 @@ --- title: New Relic exporter (via OTLP) subtitle: Configure the New Relic exporter for metrics -description: Configure the New Relic exporter for metrics via OpenTelemetry Protocol (OTLP) in the Apollo Router +description: Configure the New Relic exporter for metrics via OpenTelemetry Protocol (OTLP) in the Apollo Router. --- Enable and configure the [OTLP exporter](./otlp) for metrics in the Apollo Router for use with [New Relic](https://newrelic.com/). diff --git a/docs/source/configuration/telemetry/exporters/metrics/otlp.mdx b/docs/source/configuration/telemetry/exporters/metrics/otlp.mdx index 3bf95ca582..8a213b694a 100644 --- a/docs/source/configuration/telemetry/exporters/metrics/otlp.mdx +++ b/docs/source/configuration/telemetry/exporters/metrics/otlp.mdx @@ -1,7 +1,7 @@ --- title: OpenTelemetry Protocol (OTLP) exporter subtitle: Configure the OpenTelemetry Protocol (OTLP) exporter for metrics -description: Configure the OpenTelemetry Protocol (OTLP) exporter for metrics in the Apollo Router +description: Configure the OpenTelemetry Protocol (OTLP) exporter for metrics in the Apollo Router. --- import BatchProcessorPreamble from '../../../../../shared/batch-processor-preamble.mdx'; import BatchProcessorRef from '../../../../../shared/batch-processor-ref.mdx'; diff --git a/docs/source/configuration/telemetry/exporters/metrics/overview.mdx b/docs/source/configuration/telemetry/exporters/metrics/overview.mdx index 12f105df30..c4414d7fa4 100644 --- a/docs/source/configuration/telemetry/exporters/metrics/overview.mdx +++ b/docs/source/configuration/telemetry/exporters/metrics/overview.mdx @@ -1,7 +1,7 @@ --- title: Metrics exporters subtitle: Export Apollo Router metrics -description: Collect and export metrics from the Apollo Router for Prometheus, OpenTelemetry Protocol (OTLP), Datadog, and New Relic +description: Collect and export metrics from the Apollo Router for Prometheus, OpenTelemetry Protocol (OTLP), Datadog, and New Relic. --- The Apollo Router supports collection of metrics with [OpenTelemetry](https://opentelemetry.io/), with exporters for: diff --git a/docs/source/configuration/telemetry/exporters/metrics/prometheus.mdx b/docs/source/configuration/telemetry/exporters/metrics/prometheus.mdx index e22482dcd3..f958931d14 100644 --- a/docs/source/configuration/telemetry/exporters/metrics/prometheus.mdx +++ b/docs/source/configuration/telemetry/exporters/metrics/prometheus.mdx @@ -1,7 +1,7 @@ --- title: Prometheus exporter subtitle: Configure the Prometheus metrics exporter -description: Configure the Prometheus metrics exporter endpoint in the Apollo Router +description: Configure the Prometheus metrics exporter endpoint in the Apollo Router. --- Enable and configure the [Prometheus](https://www.prometheus.io/) exporter for metrics in the Apollo Router. diff --git a/docs/source/configuration/telemetry/exporters/tracing/datadog.mdx b/docs/source/configuration/telemetry/exporters/tracing/datadog.mdx index b889e42e3c..c8a491e760 100644 --- a/docs/source/configuration/telemetry/exporters/tracing/datadog.mdx +++ b/docs/source/configuration/telemetry/exporters/tracing/datadog.mdx @@ -1,7 +1,7 @@ --- title: Datadog exporter (via OTLP) subtitle: Configure the Datadog exporter for tracing -description: Configure the Datadog exporter for tracing via OpenTelemetry Protocol (OTLP) in the Apollo Router +description: Configure the Datadog exporter for tracing via OpenTelemetry Protocol (OTLP) in the Apollo Router. --- import BatchProcessorPreamble from '../../../../../shared/batch-processor-preamble.mdx'; import BatchProcessorRef from '../../../../../shared/batch-processor-ref.mdx'; diff --git a/docs/source/configuration/telemetry/exporters/tracing/jaeger.mdx b/docs/source/configuration/telemetry/exporters/tracing/jaeger.mdx index 978ebbf0fe..12e5c17739 100644 --- a/docs/source/configuration/telemetry/exporters/tracing/jaeger.mdx +++ b/docs/source/configuration/telemetry/exporters/tracing/jaeger.mdx @@ -1,7 +1,7 @@ --- title: Jaeger exporter (via OTLP) subtitle: Configure the Jaeger exporter for tracing -description: Configure the Jaeger exporter for tracing via OpenTelemetry Protocol (OTLP) in the Apollo Router +description: Configure the Jaeger exporter for tracing via OpenTelemetry Protocol (OTLP) in the Apollo Router. --- import BatchProcessorPreamble from '../../../../../shared/batch-processor-preamble.mdx'; diff --git a/docs/source/configuration/telemetry/exporters/tracing/new-relic.mdx b/docs/source/configuration/telemetry/exporters/tracing/new-relic.mdx index cb1775d71a..a730e4f191 100644 --- a/docs/source/configuration/telemetry/exporters/tracing/new-relic.mdx +++ b/docs/source/configuration/telemetry/exporters/tracing/new-relic.mdx @@ -1,7 +1,7 @@ --- title: New Relic exporter (via OTLP) subtitle: Configure the New Relic exporter for tracing -description: Configure the New Relic exporter for tracing via OpenTelemetry Protocol (OTLP) in the Apollo Router +description: Configure the New Relic exporter for tracing via OpenTelemetry Protocol (OTLP) in the Apollo Router. --- Enable and configure the [OTLP exporter](./otlp) for tracing in the Apollo Router for use with [New Relic](https://newrelic.com/). diff --git a/docs/source/configuration/telemetry/exporters/tracing/otlp.mdx b/docs/source/configuration/telemetry/exporters/tracing/otlp.mdx index 23888186d1..e2d7888872 100644 --- a/docs/source/configuration/telemetry/exporters/tracing/otlp.mdx +++ b/docs/source/configuration/telemetry/exporters/tracing/otlp.mdx @@ -1,7 +1,7 @@ --- title: OpenTelemetry Protocol (OTLP) exporter subtitle: Configure the OpenTelemetry Protocol exporter for tracing -description: Configure the OpenTelemetry Protocol (OTLP) exporter for tracing in the Apollo Router +description: Configure the OpenTelemetry Protocol (OTLP) exporter for tracing in the Apollo Router. --- import BatchProcessorPreamble from '../../../../../shared/batch-processor-preamble.mdx'; import BatchProcessorRef from '../../../../../shared/batch-processor-ref.mdx'; diff --git a/docs/source/configuration/telemetry/exporters/tracing/zipkin.mdx b/docs/source/configuration/telemetry/exporters/tracing/zipkin.mdx index 1901d02382..f534c940a4 100644 --- a/docs/source/configuration/telemetry/exporters/tracing/zipkin.mdx +++ b/docs/source/configuration/telemetry/exporters/tracing/zipkin.mdx @@ -1,7 +1,7 @@ --- title: Zipkin exporter subtitle: Configure the Zipkin exporter for tracing -description: Enable and configure the Zipkin exporter for tracing in the Apollo Router +description: Enable and configure the Zipkin exporter for tracing in the Apollo Router. --- import BatchProcessorPreamble from '../../../../../shared/batch-processor-preamble.mdx'; import BatchProcessorRef from '../../../../../shared/batch-processor-ref.mdx'; diff --git a/docs/source/configuration/telemetry/instrumentation/conditions.mdx b/docs/source/configuration/telemetry/instrumentation/conditions.mdx index 9c75a0ce70..238fe4db0b 100644 --- a/docs/source/configuration/telemetry/instrumentation/conditions.mdx +++ b/docs/source/configuration/telemetry/instrumentation/conditions.mdx @@ -1,7 +1,7 @@ --- title: Conditions subtitle: Set conditions for when events or instruments are triggered -description: Set conditions for when events or instruments are triggered in the Apollo Router +description: Set conditions for when events or instruments are triggered in the Apollo Router. --- You can set conditions for when an [instrument](./instruments) should be mutated or an [event](./events) should be triggered. diff --git a/docs/source/configuration/telemetry/instrumentation/standard-attributes.mdx b/docs/source/configuration/telemetry/instrumentation/standard-attributes.mdx index 2961909ba0..b96bdcb877 100644 --- a/docs/source/configuration/telemetry/instrumentation/standard-attributes.mdx +++ b/docs/source/configuration/telemetry/instrumentation/standard-attributes.mdx @@ -1,7 +1,7 @@ --- title: OpenTelemetry standard attributes subtitle: Attach standard attributes to router telemetry -description: Attach OpenTelemetry standard attributes to Apollo Router telemetry +description: Attach OpenTelemetry (OTel) standard attributes to Apollo Router telemetry. --- import RouterServices from '../../../../shared/router-lifecycle-services.mdx'; diff --git a/docs/source/configuration/telemetry/overview.mdx b/docs/source/configuration/telemetry/overview.mdx index 86513584b7..fe53b02b31 100644 --- a/docs/source/configuration/telemetry/overview.mdx +++ b/docs/source/configuration/telemetry/overview.mdx @@ -1,7 +1,7 @@ --- title: Apollo Router Telemetry subtitle: Collect observable data to monitor your router and supergraph -description: Observe and monitor the health and performance of the Apollo Router and the supergraph by collecting and exporting telemetry logs, metrics, and traces +description: Observe and monitor the health and performance of GraphQL operations in the Apollo Router by collecting and exporting telemetry logs, metrics, and traces. --- import TelemetryPerformanceNote from '../../../shared/telemetry-performance.mdx'; diff --git a/docs/source/configuration/traffic-shaping.mdx b/docs/source/configuration/traffic-shaping.mdx index 573dff2209..da93735410 100644 --- a/docs/source/configuration/traffic-shaping.mdx +++ b/docs/source/configuration/traffic-shaping.mdx @@ -1,7 +1,7 @@ --- -title: Traffic shaping in the Apollo Router -subtitle: ' ' -description: "Tune the performance and reliability of traffic to and from the Apollo Router." +title: Traffic Shaping in the Apollo Router +subtitle: Tune the performance and reliability of traffic to and from the router +description: Fine-tune traffic performance and reliability in Apollo Router with YAML configuration for client and subgraph traffic shaping. --- The Apollo Router provides various features to improve the performance and reliability of diff --git a/docs/source/containerization/docker.mdx b/docs/source/containerization/docker.mdx index 20ea2aab2a..f14037a4df 100644 --- a/docs/source/containerization/docker.mdx +++ b/docs/source/containerization/docker.mdx @@ -1,6 +1,7 @@ --- title: Run in Docker -description: Run the Apollo Router container image in Docker +subtitle: Run the Apollo Router container image in Docker +description: Run the Apollo Router container image in Docker with examples covering basic setup, configuration overrides, debugging, and building custom Docker images. --- import { Link } from "gatsby"; diff --git a/docs/source/containerization/kubernetes.mdx b/docs/source/containerization/kubernetes.mdx index 849f4a6221..8e6d483559 100644 --- a/docs/source/containerization/kubernetes.mdx +++ b/docs/source/containerization/kubernetes.mdx @@ -1,6 +1,7 @@ --- title: Deploy in Kubernetes -description: Self-hosted deployment of Apollo Router in Kubernetes +subtitle: Self-hosted deployment of Apollo Router in Kubernetes +description: Deploy the Apollo Router in Kubernetes using Helm charts. Customize configurations, enable metrics, and choose values for migration. --- import { Link } from 'gatsby'; diff --git a/docs/source/containerization/overview.mdx b/docs/source/containerization/overview.mdx index b84df29318..1dd649fa7d 100644 --- a/docs/source/containerization/overview.mdx +++ b/docs/source/containerization/overview.mdx @@ -1,6 +1,7 @@ --- title: Containerizing the Apollo Router -description: Run Apollo Router images in containers +subtitle: Run Apollo Router images in containers +description: Containerize the Apollo Router for portability and scalability. Choose from default or debug images. Deploy in Kubernetes or run in Docker. --- import ElasticNotice from '../../shared/elastic-notice.mdx'; diff --git a/docs/source/customizations/coprocessor.mdx b/docs/source/customizations/coprocessor.mdx index 5ae482d8ef..e41f4df2ca 100644 --- a/docs/source/customizations/coprocessor.mdx +++ b/docs/source/customizations/coprocessor.mdx @@ -1,6 +1,7 @@ --- -title: External coprocessing in the Apollo Router -description: Customize your router's behavior in any language +title: External Coprocessing in the Apollo Router +subtitle: Customize your router's behavior in any language +description: Customize the Apollo Router with external coprocessing. Write standalone code in any language, hook into request lifecycle, and modify request/response details. --- import CoprocTypicalConfig from '../../shared/coproc-typical-config.mdx'; diff --git a/docs/source/customizations/custom-binary.mdx b/docs/source/customizations/custom-binary.mdx index 0ef949bba9..4af39b9281 100644 --- a/docs/source/customizations/custom-binary.mdx +++ b/docs/source/customizations/custom-binary.mdx @@ -1,6 +1,7 @@ --- -title: Creating a custom Apollo Router binary -description: Compile a custom router binary from source +title: Creating a Custom Apollo Router Binary +subtitle: Compile a custom router binary from source +description: Compile a custom Apollo Router binary from source. Learn to create native Rust plugins. --- import ElasticNotice from '../../shared/elastic-notice.mdx'; diff --git a/docs/source/customizations/native.mdx b/docs/source/customizations/native.mdx index 616e051cf4..b297cb1670 100644 --- a/docs/source/customizations/native.mdx +++ b/docs/source/customizations/native.mdx @@ -1,6 +1,7 @@ --- -title: Writing native Rust plugins for the Apollo Router -description: Extend the Apollo Router with custom Rust code +title: Writing Native Rust Plugins for the Apollo Router +subtitle: Extend the Apollo Router with custom Rust code +description: Extend the Apollo Router with custom Rust code. Plan, build, and register plugins. Define plugin configuration and implement lifecycle hooks. --- import ElasticNotice from '../../shared/elastic-notice.mdx'; diff --git a/docs/source/customizations/overview.mdx b/docs/source/customizations/overview.mdx index bef1c895fd..a8ead13ec4 100644 --- a/docs/source/customizations/overview.mdx +++ b/docs/source/customizations/overview.mdx @@ -1,6 +1,7 @@ --- -title: Apollo Router customizations -description: Extend your router with custom functionality +title: Apollo Router Customizations +subtitle: Extend your router with custom functionality +description: Extend the Apollo Router with custom functionality. Understand the request lifecycle and how customizations intervene at specific points. --- You can create **customizations** for the Apollo Router to add functionality that isn't available via built-in [configuration options](../configuration/overview/). For example, you can make an external call to fetch authentication data for each incoming request. diff --git a/docs/source/customizations/rhai-api.mdx b/docs/source/customizations/rhai-api.mdx index eff41b4666..c5ab8ebc58 100644 --- a/docs/source/customizations/rhai-api.mdx +++ b/docs/source/customizations/rhai-api.mdx @@ -1,6 +1,7 @@ --- -title: Rhai script API reference -description: For Apollo Router customizations +title: Rhai Script API Reference +subtitle: For Apollo Router customizations +description: This reference documents the symbols and behaviors that are specific to Rhai customizations for the Apollo Router. Includes entry point hooks, logging, and more. --- This reference documents the symbols and behaviors that are specific to [Rhai customizations](./rhai/) for the Apollo Router. diff --git a/docs/source/customizations/rhai.mdx b/docs/source/customizations/rhai.mdx index a76729557c..710f4171a5 100644 --- a/docs/source/customizations/rhai.mdx +++ b/docs/source/customizations/rhai.mdx @@ -1,6 +1,7 @@ --- -title: Rhai scripts for the Apollo Router -description: Add custom functionality directly to your router +title: Rhai Scripts for the Apollo Router +subtitle: Add custom functionality directly to your router +description: Customize Apollo Router functionality with Rhai scripts. Manipulate strings, process headers and more for enhanced performance. --- You can customize the Apollo Router's behavior with scripts that use the [Rhai scripting language](https://rhai.rs/book/). In a Rust-based project, Rhai is ideal for performing common scripting tasks such as manipulating strings and processing headers. Your Rhai scripts can also hook into multiple stages of the router's [request handling lifecycle](#router-request-lifecycle). diff --git a/docs/source/enterprise-features.mdx b/docs/source/enterprise-features.mdx index 797d093822..11e45d20d6 100644 --- a/docs/source/enterprise-features.mdx +++ b/docs/source/enterprise-features.mdx @@ -1,6 +1,7 @@ --- -title: Enterprise features for the Apollo Router -description: Available with GraphOS Enterprise +title: Enterprise Features of the Apollo Router +subtitle: Connect the router to GraphOS for advanced features +description: Unlock Enterprise features for the Apollo Router by connecting it to GraphOS. Enable offline licenses for extended disconnections. --- Since the Apollo Router is [source-available](https://www.apollographql.com/blog/evaluating-apollo-router-understanding-free-and-open-vs-commercial-features), you can use its codebase without connecting it to GraphOS. GraphOS organizations with the Enterprise plan can [connect a self-hosted router to GraphOS](/graphos/quickstart/self-hosted#6-connect-the-router-to-graphos) for an expanded feature set. diff --git a/docs/source/errors.mdx b/docs/source/errors.mdx index 7b7cb8d43b..a72397aed4 100644 --- a/docs/source/errors.mdx +++ b/docs/source/errors.mdx @@ -1,7 +1,7 @@ --- title: Errors subtitle: Error and status codes returned by the Apollo Router -description: Error codes and HTTP response status codes returned by the Apollo Router +description: Reference for error and HTTP status codes returned by the Apollo Router, including explanations and solutions. --- Learn about error codes and HTTP response status codes returned by the Apollo Router. diff --git a/docs/source/executing-operations/build-run-queries.mdx b/docs/source/executing-operations/build-run-queries.mdx index fb929793a9..6303cab506 100644 --- a/docs/source/executing-operations/build-run-queries.mdx +++ b/docs/source/executing-operations/build-run-queries.mdx @@ -1,5 +1,7 @@ --- -title: Build and run queries against the Apollo Router +title: Build and Run Queries +subtitle: Use the Apollo Sandbox to build and run operations against your router +description: Use the Apollo Sandbox, a special mode of GraphOS Studio, to build and run GraphQL operations against your graph router. --- The Apollo Router serves the following landing page from its base URL (`http://localhost:4000` by default): @@ -8,6 +10,6 @@ The Apollo Router serves the following landing page from its base URL (`http://l ## Apollo Sandbox -The landing page above provides a link to [Apollo Sandbox](https://studio.apollographql.com/sandbox), a powerful web IDE that enables you to build and run operations against your router. Sandbox is a special mode of [Apollo Studio](https://www.apollographql.com/docs/studio/) that doesn't require an Apollo account. +The landing page above provides a link to [Apollo Sandbox](https://studio.apollographql.com/sandbox), a powerful web IDE that enables you to build and run operations against your router. Sandbox is a special mode of [GraphOS Studio](https://www.apollographql.com/docs/studio/) that doesn't require an Apollo account. Apollo Sandbox diff --git a/docs/source/executing-operations/defer-support.mdx b/docs/source/executing-operations/defer-support.mdx index 9d2c1b8858..65e87bc208 100644 --- a/docs/source/executing-operations/defer-support.mdx +++ b/docs/source/executing-operations/defer-support.mdx @@ -1,6 +1,7 @@ --- -title: Apollo Router support for @defer -description: Improve performance by delivering fields incrementally +title: Apollo Router Support for @defer +subtitle: Improve performance by delivering fields incrementally +description: Improve your GraphQL query performance with Apollo Router's support for the @defer directive. Incrementally deliver response data by deferring certain fields. minVersion: 1.8.0 --- diff --git a/docs/source/executing-operations/query-batching.mdx b/docs/source/executing-operations/query-batching.mdx index e9b6ed9537..7058c91249 100644 --- a/docs/source/executing-operations/query-batching.mdx +++ b/docs/source/executing-operations/query-batching.mdx @@ -1,6 +1,7 @@ --- -title: Query batching -description: Receive query batches with the Apollo Router +title: Query Batching +subtitle: Receive query batches with the Apollo Router +description: Handle multiple GraphQL requests with Apollo Router's query batching capabilities. Aggregate operations into single HTTP requests, reducing overhead. --- diff --git a/docs/source/executing-operations/requests.mdx b/docs/source/executing-operations/requests.mdx index a99f2dea1e..db6f9f88b2 100644 --- a/docs/source/executing-operations/requests.mdx +++ b/docs/source/executing-operations/requests.mdx @@ -1,6 +1,7 @@ --- -title: Operation request format -description: How to send requests to the Apollo Router over HTTP +title: Operation Request Format +subtitle: Send requests to the Apollo Router over HTTP +description: Learn how to format and send GraphQL requests to Apollo Router over HTTP. Explore POST and GET examples and the automatic persisted queries protocol. --- By default, almost every GraphQL IDE and client library takes care of sending operations in a format that the Apollo Router supports. This article describes that format, which is also described on [graphql.org](https://graphql.org/learn/serving-over-http/) and in [this preliminary spec](https://github.com/graphql/graphql-over-http). diff --git a/docs/source/executing-operations/subscription-callback-protocol.mdx b/docs/source/executing-operations/subscription-callback-protocol.mdx index dd9dd125d5..2fbf2a7431 100644 --- a/docs/source/executing-operations/subscription-callback-protocol.mdx +++ b/docs/source/executing-operations/subscription-callback-protocol.mdx @@ -1,6 +1,7 @@ --- -title: HTTP callback protocol for GraphQL subscriptions -description: For federated subgraphs communicating with the Apollo Router +title: HTTP Callback Protocol for GraphQL Subscriptions +subtitle: Enable clients to receive real-time updates via HTTP callback +description: Understand the HTTP Callback Protocol for GraphQL Subscriptions with the Apollo Router. Learn initialization, main loop, message types, and error handling. --- This reference describes a protocol for GraphQL servers (or **subgraphs**) to send subscription data to a subscribing **graph router** (such as the Apollo Router) via HTTP callbacks. Use this reference if you're adding support for this protocol to a GraphQL server library or other system. diff --git a/docs/source/executing-operations/subscription-multipart-protocol.mdx b/docs/source/executing-operations/subscription-multipart-protocol.mdx index 00e910123e..3842f3a382 100644 --- a/docs/source/executing-operations/subscription-multipart-protocol.mdx +++ b/docs/source/executing-operations/subscription-multipart-protocol.mdx @@ -1,6 +1,7 @@ --- -title: Multipart HTTP protocol for GraphQL subscriptions -description: For GraphQL clients communicating with the Apollo Router +title: Multipart HTTP protocol for GraphQL Subscriptions +subtitle: Enable clients to receive real-time updates via multipart HTTP protocol +description: Enable real-time updates via multipart HTTP protocol for GraphQL subscriptions with the Apollo Router. Learn about execution, heartbeats, and error handling. --- To execute GraphQL subscription operations on the Apollo Router, client apps do _not_ communicate over WebSocket. Instead, they use **HTTP with multipart responses**. This multipart protocol is built on the same [Incremental Delivery over HTTP](https://github.com/graphql/graphql-over-http/blob/main/rfcs/IncrementalDelivery.md) spec that the Apollo Router uses to support [the `@defer` directive](./defer-support/). diff --git a/docs/source/executing-operations/subscription-support.mdx b/docs/source/executing-operations/subscription-support.mdx index 8d22dafc44..2c0029da65 100644 --- a/docs/source/executing-operations/subscription-support.mdx +++ b/docs/source/executing-operations/subscription-support.mdx @@ -1,5 +1,5 @@ --- -title: Configure GraphQL subscription support +title: Configure GraphQL Subscription Support subtitle: Enable clients to receive real-time updates description: Configure your router to support GraphQL subscriptions, enabling clients to receive real-time updates via WebSocket or HTTP callbacks. minVersion: 1.22.0 diff --git a/docs/source/federation-version-support.mdx b/docs/source/federation-version-support.mdx index 7205400590..66194e4204 100644 --- a/docs/source/federation-version-support.mdx +++ b/docs/source/federation-version-support.mdx @@ -1,5 +1,7 @@ --- -title: Federation version support in the Apollo Router +title: Federation Version Support in the Apollo Router +subtitle: Check router version compatibility with Apollo Federation versions +description: This reference shows which version of Apollo Federation each Apollo Router release is compiled against. Ensure your router uses at least the listed federation version. --- The Apollo Router supports supergraph schemas that are generated via Apollo Federation 2.x [composition](/federation/federated-types/composition/). This composition algorithm is usually performed by one of the following: diff --git a/docs/source/index.mdx b/docs/source/index.mdx index aa9e9eb704..c4aaf69172 100644 --- a/docs/source/index.mdx +++ b/docs/source/index.mdx @@ -1,6 +1,7 @@ --- title: The Apollo Router -description: High-performance routing for self-hosted supergraphs +subtitle: High-performance routing for self-hosted supergraphs +description: Distribute operations efficiently across microservices in your federated GraphQL API with the Apollo Router. Configure caching, security features, and more. --- import { Link } from 'gatsby'; diff --git a/docs/source/managed-federation/client-awareness.mdx b/docs/source/managed-federation/client-awareness.mdx index 633b467467..29f37350a8 100644 --- a/docs/source/managed-federation/client-awareness.mdx +++ b/docs/source/managed-federation/client-awareness.mdx @@ -5,7 +5,7 @@ description: Configure client awareness in Apollo Router import { Link } from "gatsby"; -The Apollo Router supports [client awareness](/graphos/metrics/client-awareness/) by default. If the client sets the headers `apollographql-client-name` and `apollographql-client-version` in its HTTP requests, Apollo Studio can separate the metrics and queries per client. +The Apollo Router supports [client awareness](/graphos/metrics/client-awareness/) by default. If the client sets the headers `apollographql-client-name` and `apollographql-client-version` in its HTTP requests, GraphOS Studio can separate the metrics and queries per client. ## Overriding client awareness headers @@ -20,6 +20,6 @@ telemetry: client_version_header: MyClientHeaderVersion cors: # The headers to allow. - # (Defaults to [ Content-Type ], which is required for Apollo Studio) + # (Defaults to [ Content-Type ], which is required for GraphOS Studio) allow_headers: [ Content-Type, MyClientHeaderName, MyClientHeaderVersion] ``` diff --git a/docs/source/migrating-from-gateway.mdx b/docs/source/migrating-from-gateway.mdx index 995e48f1a0..6cfc30d7b3 100644 --- a/docs/source/migrating-from-gateway.mdx +++ b/docs/source/migrating-from-gateway.mdx @@ -1,6 +1,7 @@ --- -title: Gateway migration guide -description: Migrating to the Apollo Router from @apollo/gateway +title: Gateway Migration Guide +subtitle: Migrating to the Apollo Router from @apollo/gateway +description: Learn how to migrate a federated graph from @apollo/gateway to the Apollo Router without any changes to your subgraphs. --- Learn how to migrate a federated supergraph using the `@apollo/gateway` library to the Apollo Router and gain significant performance improvements while making zero changes to your subgraphs. @@ -32,7 +33,7 @@ The sections below provide more details on what to look for in each of these cat ## Environment variables -Many Apollo tools use environment variables prefixed with `APOLLO_` to set certain values, such as an API key for communicating with Apollo Studio. +Many Apollo tools use environment variables prefixed with `APOLLO_` to set certain values, such as an API key for communicating with GraphOS Studio. Make sure to note any environment variables you set in your existing gateway's environment, _especially_ those prefixed with `APOLLO_` diff --git a/docs/source/migrating-from-version-0.x.mdx b/docs/source/migrating-from-version-0.x.mdx index 246fb36709..92031d5068 100644 --- a/docs/source/migrating-from-version-0.x.mdx +++ b/docs/source/migrating-from-version-0.x.mdx @@ -1,5 +1,7 @@ --- -title: Upgrading from versions prior to 1.0 +title: Upgrading from Versions Prior to 1.0 +subtitle: Migrate from version 0.x to 1.x of the Apollo Router +description: Learn how to migrate a federated graph from pre-1.0 versions to Apollo Router 1.x for enhanced performance and streamlined configuration. --- If you were using versions of Apollo Router prior to the 1.0 release, thank you for being an early adopter! This article describes how to migrate from various pre-1.0 releases to the 1.x version. We recommend upgrading to 1.x versions and away from pre-release versions prior to 1.0 since bug-fixes and improvements will no longer be shipped to pre-1.0 versions once the 1.x version is released. @@ -67,7 +69,7 @@ The sections below provide more details on what to look for in each of these cat ## Environment variables -Many Apollo tools use environment variables prefixed with `APOLLO_` to set certain values, such as an API key for communicating with Apollo Studio. +Many Apollo tools use environment variables prefixed with `APOLLO_` to set certain values, such as an API key for communicating with GraphOS Studio. Make sure to note any environment variables you set in your existing gateway's environment, _especially_ those prefixed with `APOLLO_` diff --git a/docs/source/privacy.mdx b/docs/source/privacy.mdx index 05326fe2ec..823dfe4f75 100644 --- a/docs/source/privacy.mdx +++ b/docs/source/privacy.mdx @@ -1,5 +1,7 @@ --- -title: Privacy and data collection +title: Privacy and Data Collection +subtitle: Learn what data the Apollo Router collects and how to opt out +description: Learn what data the Apollo Router collects and how to opt out. By default, the Apollo Router collects anonymous usage data to help improve the product. --- By default, the Apollo Router collects anonymous usage data to help us improve the product. diff --git a/docs/source/quickstart.mdx b/docs/source/quickstart.mdx index 42914968ea..9ab5303a9e 100644 --- a/docs/source/quickstart.mdx +++ b/docs/source/quickstart.mdx @@ -1,6 +1,7 @@ --- -title: Apollo Router quickstart -description: Run the Apollo Router with Apollo-hosted subgraphs +title: Apollo Router Quickstart +subtitle: Run the Apollo Router with Apollo-hosted subgraphs +description: This quickstart tutorial walks you through installing the Apollo Router and running it in front of some Apollo-hosted example subgraphs. --- import ElasticNotice from '../shared/elastic-notice.mdx';