Skip to content

Commit

Permalink
reorg dev docs for new docs IA (#6248)
Browse files Browse the repository at this point in the history
  • Loading branch information
shorgi authored Nov 8, 2024
1 parent b09bda0 commit fd955e3
Show file tree
Hide file tree
Showing 136 changed files with 4,942 additions and 895 deletions.
2 changes: 1 addition & 1 deletion docs/shared/native-plugin-notice.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
- Native plugins require familiarity with programming in Rust.
- Native plugins require compiling a custom router binary from source, which can introduce unexpected behavior in your router that's difficult to diagnose and support.

Instead, for most router customizations, Apollo recommends creating either a [Rhai script](https://www.apollographql.com/docs/router/customizations/rhai/) or an [external coprocessor](https://www.apollographql.com/docs/router/customizations/coprocessor). Both of these customizations are supported by Apollo and provide strong separation of concerns and fault isolation.
Instead, for most router customizations, Apollo recommends creating either a [Rhai script](https://www.apollographql.com/docs/graphos/routing/customization/rhai/) or an [external coprocessor](https://www.apollographql.com/docs/router/customizations/coprocessor). Both of these customizations are supported by Apollo and provide strong separation of concerns and fault isolation.

If you must create a native plugin, please [open a GitHub issue](https://github.com/apollographql/router/issues), and Apollo can investigate adding the custom capability to the stock router binary.
128 changes: 7 additions & 121 deletions docs/source/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,130 +2,16 @@
"title": "Self-Hosted Router",
"algoliaFilters": ["docset:router"],
"sidebar": {
"Introduction": "/",
"Quickstart": "/quickstart",
"Moving from @apollo/gateway": "/migrating-from-gateway",
"Federation Version Support": "/federation-version-support",
"Enterprise Features": ["/enterprise-features", ["enterprise"]],
"Configuring the Router": {
"Overview": "/configuration/overview",
"Caching": {
"In-Memory Caching": "/configuration/in-memory-caching",
"Distributed Caching": ["/configuration/distributed-caching", ["enterprise"]],
"Entity Caching": ["/configuration/entity-caching", ["enterprise", "preview"]]
},
"Debugging": {
"Errors": "/errors",
"Telemetry": "/configuration/telemetry/overview",
"Subgraph Error Inclusion": "/configuration/subgraph-error-inclusion"
},
"Networking": {
"Header Propagation": "/configuration/header-propagation",
"Traffic Shaping": "/configuration/traffic-shaping"
},
"Security": {
"CORS": "/configuration/cors",
"CSRF Prevention": "/configuration/csrf",
"JWT Authentication": ["/configuration/authn-jwt", ["enterprise"]],
"Authorization": ["/configuration/authorization", ["enterprise"]],
"Subgraph Authentication": "/configuration/authn-subgraph",
"Operation Limits": [
"/configuration/operation-limits",
[
"enterprise"
]
],
"Safelisting with Persisted Queries": [
"/configuration/persisted-queries",
[
"enterprise"
]
],
"Demand Control" : [
"/executing-operations/demand-control",
[
"enterprise"
]
],
"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": [
"/executing-operations/query-batching",
[
"enterprise"
]
],
"GraphQL Subscriptions": {
"Subscriptions Setup": ["/executing-operations/subscription-support", ["enterprise"]],
"Subgraph Protocol: HTTP Callback": [
"/executing-operations/subscription-callback-protocol",
["enterprise", "preview"]
],
"Client Protocol: HTTP Multipart": ["/executing-operations/subscription-multipart-protocol", ["enterprise"]]
}
"Routing": {
"About Router": "/routing/about-router"
},
"Telemetry and Monitoring": {
"Overview": "/configuration/telemetry/overview",
"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"
"Reference": {
"Migration": {
"From Gateway": "/reference/migration/from-gateway"
},
"Metrics Exporters": {
"Configuration": "/configuration/telemetry/exporters/metrics/overview",
"Datadog": "/configuration/telemetry/exporters/metrics/datadog",
"Dynatrace": "/configuration/telemetry/exporters/metrics/dynatrace",
"New Relic": "/configuration/telemetry/exporters/metrics/new-relic",
"OTLP": "/configuration/telemetry/exporters/metrics/otlp",
"Prometheus": "/configuration/telemetry/exporters/metrics/prometheus"
},
"Trace exporters": {
"Configuration": "/configuration/telemetry/exporters/tracing/overview",
"Datadog": "/configuration/telemetry/exporters/tracing/datadog",
"Dynatrace": "/configuration/telemetry/exporters/tracing/dynatrace",
"Jaeger": "/configuration/telemetry/exporters/tracing/jaeger",
"New Relic": "/configuration/telemetry/exporters/tracing/new-relic",
"OTLP": "/configuration/telemetry/exporters/tracing/otlp",
"Zipkin": "/configuration/telemetry/exporters/tracing/zipkin"
},
"Instrumentation": {
"Instruments": "/configuration/telemetry/instrumentation/instruments",
"Events": "/configuration/telemetry/instrumentation/events",
"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"
"Router": {
"Configuration": "/reference/router/configuration"
}
},
"Containerization": {
"Overview": "/containerization/overview",
"Deploy on Kubernetes": "/containerization/kubernetes",
"Run with Docker": "/containerization/docker",
"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"
},
"Customizations": {
"Overview": "/customizations/overview",
"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"
},
"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/"
}
}
}
34 changes: 0 additions & 34 deletions docs/source/configuration/experimental_query_planner_mode.mdx

This file was deleted.

15 changes: 0 additions & 15 deletions docs/source/executing-operations/build-run-queries.mdx

This file was deleted.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit fd955e3

Please sign in to comment.