From 216f3febad34d4f848e84ac76b914bf91a3f8645 Mon Sep 17 00:00:00 2001 From: Maria Elisabeth Schreiber Date: Mon, 27 Jan 2025 12:46:33 -0700 Subject: [PATCH 1/2] Update sidebar file --- docs/source/_sidebar.yaml | 153 ++++++++++++++++++++++++++++++++++++++ docs/source/config.json | 97 ------------------------ 2 files changed, 153 insertions(+), 97 deletions(-) create mode 100644 docs/source/_sidebar.yaml delete mode 100644 docs/source/config.json diff --git a/docs/source/_sidebar.yaml b/docs/source/_sidebar.yaml new file mode 100644 index 00000000000..736ff3b2cbc --- /dev/null +++ b/docs/source/_sidebar.yaml @@ -0,0 +1,153 @@ +switcher: + heading: "Apollo Server" + versions: + - label: v4 + latest: true + href: ./ + - label: v3 + href: ./v3 + - label: v2 + href: ./v2 +items: + - label: Introduction + href: "." + - label: Get started + href: "./getting-started" + - label: New in v4 + children: + - label: Migrating to Apollo Server 4 + href: "./migration" + - label: Previous versions + href: "./previous-versions" + - label: Changelog + href: "https://github.com/apollographql/apollo-server/blob/main/packages/server/CHANGELOG.md" + - label: Defining a Schema + children: + - label: Schema basics + href: "./schema/schema" + - label: Unions and interfaces + href: "./schema/unions-interfaces" + - label: Custom scalars + href: "./schema/custom-scalars" + - label: Directives + href: "./schema/directives" + - label: Resolving Operations + children: + - label: Resolvers + href: "./data/resolvers" + - label: Sharing context + href: "./data/context" + - label: Error handling + href: "./data/errors" + - label: Subscriptions + href: "./data/subscriptions" + - label: Fetching Data + children: + - label: Overview + href: "./data/fetching-data" + - label: REST APIs + href: "./data/fetching-rest" + - label: Web Frameworks + children: + - label: Integrations + href: "./integrations/integration-index" + - label: Building integrations + href: "./integrations/building-integrations" + - label: MERN stack tutorial + href: "./integrations/mern" + - label: Development Workflow + children: + - label: Build and run queries + href: "./workflow/build-run-queries" + - label: Request format + href: "./workflow/requests" + - label: Generating TS types + href: "./workflow/generate-types" + - label: Mocking + href: "./testing/mocking" + - label: Integration testing + href: "./testing/testing" + - label: Apollo Studio Explorer + href: "https://www.apollographql.com/docs/studio/explorer/" + - label: Performance + children: + - label: Caching + href: "./performance/caching" + - label: Cache backends + href: "./performance/cache-backends" + - label: Response Cache Eviction + href: "./performance/response-cache-eviction" + - label: Automatic persisted queries + href: "./performance/apq" + - label: Security + children: + - label: Auth + href: "./security/authentication" + - label: CORS + href: "./security/cors" + - label: Terminating SSL + href: "./security/terminating-ssl" + - label: Proxy configuration + href: "./security/proxy-configuration" + - label: Deployment + children: + - label: Lambda + href: "./deployment/lambda" + - label: Heroku + href: "./deployment/heroku" + - label: Monitoring + children: + - label: Metrics and logging + href: "./monitoring/metrics" + - label: Health checks + href: "./monitoring/health-checks" + - label: API Reference + children: + - label: ApolloServer + href: "./api/apollo-server" + - label: startStandaloneServer + href: "./api/standalone" + - label: expressMiddleware + href: "./api/express-middleware" + - label: Plugins + children: + - label: Overview + href: "./builtin-plugins" + - label: Built-in + children: + - label: Usage reporting + href: "./api/plugin/usage-reporting" + - label: Schema reporting + href: "./api/plugin/schema-reporting" + - label: Inline trace + href: "./api/plugin/inline-trace" + - label: Drain HTTP server + href: "./api/plugin/drain-http-server" + - label: Cache control + href: "./api/plugin/cache-control" + - label: Landing pages + href: "./api/plugin/landing-pages" + - label: Federated subscriptions + href: "./api/plugin/subscription-callback" + - label: Custom + children: + - label: Creating plugins + href: "./integrations/plugins" + - label: Event reference + href: "./integrations/plugins-event-reference" + - label: Using with Federation + children: + - label: As a subgraph + children: + - label: Setup + href: "./using-federation/apollo-subgraph-setup" + - label: "@apollo/subgraph reference" + href: "./using-federation/api/apollo-subgraph/" + - label: As a gateway + children: + - label: Setup + href: "./using-federation/apollo-gateway-setup" + - label: Gateway performance + href: "./using-federation/gateway-performance" + - label: "@apollo/gateway reference" + href: "./using-federation/api/apollo-gateway/" diff --git a/docs/source/config.json b/docs/source/config.json deleted file mode 100644 index 8e4be099ff7..00000000000 --- a/docs/source/config.json +++ /dev/null @@ -1,97 +0,0 @@ -{ - "title": "Apollo Server", - "version": "v4", - "algoliaFilters": [ - "docset:apollo-server", - ["docset:apollo-client", "docset:federation"] - ], - "sidebar": { - "Introduction": "/", - "Get Started": "/getting-started", - "New in v4": { - "Migrating to Apollo Server 4": "/migration", - "Previous Versions": "/previous-versions", - "Changelog": "https://github.com/apollographql/apollo-server/blob/main/packages/server/CHANGELOG.md" - }, - "Defining a Schema": { - "Schema Basics": "/schema/schema", - "Unions and Interfaces": "/schema/unions-interfaces", - "Custom Scalars": "/schema/custom-scalars", - "Directives": "/schema/directives" - }, - "Resolving Operations": { - "Resolvers": "/data/resolvers", - "Sharing Context": "/data/context", - "Error Handling": "/data/errors", - "Subscriptions": "/data/subscriptions" - }, - "Fetching Data": { - "Overview": "/data/fetching-data", - "REST APIs": "/data/fetching-rest" - }, - "Web Frameworks": { - "Integrations": "/integrations/integration-index", - "Building Integrations": "/integrations/building-integrations", - "MERN Stack Tutorial": "/integrations/mern" - }, - "Development Workflow": { - "Build and Run Queries": "/workflow/build-run-queries", - "Request Format": "/workflow/requests", - "Generating TS Types": "/workflow/generate-types", - "Mocking": "/testing/mocking", - "Integration Testing": "/testing/testing" - }, - "Performance": { - "Caching": "/performance/caching", - "Cache Backends": "/performance/cache-backends", - "Response Cache Eviction": "/performance/response-cache-eviction", - "Automatic Persisted Queries": "/performance/apq" - }, - "Security": { - "Authentication and Authorization": "/security/authentication", - "CORS": "/security/cors", - "Terminating SSL": "/security/terminating-ssl", - "Proxy Configuration": "/security/proxy-configuration" - }, - "Deployment": { - "Lambda": "/deployment/lambda", - "Heroku": "/deployment/heroku" - }, - "Monitoring": { - "Metrics and Logging": "/monitoring/metrics", - "Health Checks": "/monitoring/health-checks" - }, - "API Reference": { - "ApolloServer": "/api/apollo-server", - "startStandaloneServer": "/api/standalone", - "expressMiddleware": "/api/express-middleware" - }, - "Plugins": { - "Overview": "/builtin-plugins", - "Built-In": { - "Usage Reporting": "/api/plugin/usage-reporting", - "Schema Reporting": "/api/plugin/schema-reporting", - "Inline Trace": "/api/plugin/inline-trace", - "Drain HTTP Server": "/api/plugin/drain-http-server", - "Cache Control": "/api/plugin/cache-control", - "Landing Pages": "/api/plugin/landing-pages", - "Federated Subscriptions": "/api/plugin/subscription-callback" - }, - "Custom": { - "Creating Plugins": "/integrations/plugins", - "Event Reference": "/integrations/plugins-event-reference" - } - }, - "Using with Federation": { - "As a Subgraph": { - "Setup": "/using-federation/apollo-subgraph-setup", - "@apollo/subgraph reference": "/using-federation/api/apollo-subgraph/" - }, - "As a Gateway": { - "Setup": "/using-federation/apollo-gateway-setup", - "Performance Optimizations": "/using-federation/gateway-performance", - "@apollo/gateway Reference": "/using-federation/api/apollo-gateway/" - } - } - } -} From e54970259b8c43b25b8c72e70abf55a34f6325af Mon Sep 17 00:00:00 2001 From: Maria Elisabeth Schreiber Date: Mon, 27 Jan 2025 13:06:28 -0700 Subject: [PATCH 2/2] Lint --- docs/source/_sidebar.yaml | 114 +++++++++++++++++++------------------- 1 file changed, 57 insertions(+), 57 deletions(-) diff --git a/docs/source/_sidebar.yaml b/docs/source/_sidebar.yaml index 736ff3b2cbc..51db08d74b0 100644 --- a/docs/source/_sidebar.yaml +++ b/docs/source/_sidebar.yaml @@ -1,5 +1,5 @@ switcher: - heading: "Apollo Server" + heading: 'Apollo Server' versions: - label: v4 latest: true @@ -10,144 +10,144 @@ switcher: href: ./v2 items: - label: Introduction - href: "." + href: '.' - label: Get started - href: "./getting-started" + href: './getting-started' - label: New in v4 children: - label: Migrating to Apollo Server 4 - href: "./migration" + href: './migration' - label: Previous versions - href: "./previous-versions" + href: './previous-versions' - label: Changelog - href: "https://github.com/apollographql/apollo-server/blob/main/packages/server/CHANGELOG.md" + href: 'https://github.com/apollographql/apollo-server/blob/main/packages/server/CHANGELOG.md' - label: Defining a Schema children: - label: Schema basics - href: "./schema/schema" + href: './schema/schema' - label: Unions and interfaces - href: "./schema/unions-interfaces" + href: './schema/unions-interfaces' - label: Custom scalars - href: "./schema/custom-scalars" + href: './schema/custom-scalars' - label: Directives - href: "./schema/directives" + href: './schema/directives' - label: Resolving Operations children: - label: Resolvers - href: "./data/resolvers" + href: './data/resolvers' - label: Sharing context - href: "./data/context" + href: './data/context' - label: Error handling - href: "./data/errors" + href: './data/errors' - label: Subscriptions - href: "./data/subscriptions" + href: './data/subscriptions' - label: Fetching Data children: - label: Overview - href: "./data/fetching-data" + href: './data/fetching-data' - label: REST APIs - href: "./data/fetching-rest" + href: './data/fetching-rest' - label: Web Frameworks children: - label: Integrations - href: "./integrations/integration-index" + href: './integrations/integration-index' - label: Building integrations - href: "./integrations/building-integrations" + href: './integrations/building-integrations' - label: MERN stack tutorial - href: "./integrations/mern" + href: './integrations/mern' - label: Development Workflow children: - label: Build and run queries - href: "./workflow/build-run-queries" + href: './workflow/build-run-queries' - label: Request format - href: "./workflow/requests" + href: './workflow/requests' - label: Generating TS types - href: "./workflow/generate-types" + href: './workflow/generate-types' - label: Mocking - href: "./testing/mocking" + href: './testing/mocking' - label: Integration testing - href: "./testing/testing" + href: './testing/testing' - label: Apollo Studio Explorer - href: "https://www.apollographql.com/docs/studio/explorer/" + href: 'https://www.apollographql.com/docs/studio/explorer/' - label: Performance children: - label: Caching - href: "./performance/caching" + href: './performance/caching' - label: Cache backends - href: "./performance/cache-backends" + href: './performance/cache-backends' - label: Response Cache Eviction - href: "./performance/response-cache-eviction" + href: './performance/response-cache-eviction' - label: Automatic persisted queries - href: "./performance/apq" + href: './performance/apq' - label: Security children: - label: Auth - href: "./security/authentication" + href: './security/authentication' - label: CORS - href: "./security/cors" + href: './security/cors' - label: Terminating SSL - href: "./security/terminating-ssl" + href: './security/terminating-ssl' - label: Proxy configuration - href: "./security/proxy-configuration" + href: './security/proxy-configuration' - label: Deployment children: - label: Lambda - href: "./deployment/lambda" + href: './deployment/lambda' - label: Heroku - href: "./deployment/heroku" + href: './deployment/heroku' - label: Monitoring children: - label: Metrics and logging - href: "./monitoring/metrics" + href: './monitoring/metrics' - label: Health checks - href: "./monitoring/health-checks" + href: './monitoring/health-checks' - label: API Reference children: - label: ApolloServer - href: "./api/apollo-server" + href: './api/apollo-server' - label: startStandaloneServer - href: "./api/standalone" + href: './api/standalone' - label: expressMiddleware - href: "./api/express-middleware" + href: './api/express-middleware' - label: Plugins children: - label: Overview - href: "./builtin-plugins" + href: './builtin-plugins' - label: Built-in children: - label: Usage reporting - href: "./api/plugin/usage-reporting" + href: './api/plugin/usage-reporting' - label: Schema reporting - href: "./api/plugin/schema-reporting" + href: './api/plugin/schema-reporting' - label: Inline trace - href: "./api/plugin/inline-trace" + href: './api/plugin/inline-trace' - label: Drain HTTP server - href: "./api/plugin/drain-http-server" + href: './api/plugin/drain-http-server' - label: Cache control - href: "./api/plugin/cache-control" + href: './api/plugin/cache-control' - label: Landing pages - href: "./api/plugin/landing-pages" + href: './api/plugin/landing-pages' - label: Federated subscriptions - href: "./api/plugin/subscription-callback" + href: './api/plugin/subscription-callback' - label: Custom children: - label: Creating plugins - href: "./integrations/plugins" + href: './integrations/plugins' - label: Event reference - href: "./integrations/plugins-event-reference" + href: './integrations/plugins-event-reference' - label: Using with Federation children: - label: As a subgraph children: - label: Setup - href: "./using-federation/apollo-subgraph-setup" - - label: "@apollo/subgraph reference" - href: "./using-federation/api/apollo-subgraph/" + href: './using-federation/apollo-subgraph-setup' + - label: '@apollo/subgraph reference' + href: './using-federation/api/apollo-subgraph/' - label: As a gateway children: - label: Setup - href: "./using-federation/apollo-gateway-setup" + href: './using-federation/apollo-gateway-setup' - label: Gateway performance - href: "./using-federation/gateway-performance" - - label: "@apollo/gateway reference" - href: "./using-federation/api/apollo-gateway/" + href: './using-federation/gateway-performance' + - label: '@apollo/gateway reference' + href: './using-federation/api/apollo-gateway/'