From f736163f4303cf46d786c1d312c2b19577ca3c85 Mon Sep 17 00:00:00 2001 From: Maria Elisabeth Schreiber Date: Thu, 21 Mar 2024 15:35:33 -0600 Subject: [PATCH] docs: update links (#2966) Fixes some incorrect documentation links --- README.md | 2 +- docs/source/config.json | 2 +- docs/source/migrating-from-stitching.md | 8 ++++---- docs/source/performance/monitoring.mdx | 6 +++--- docs/source/quickstart/setup.mdx | 2 +- docs/source/quickstart/studio-composition.mdx | 2 +- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 0c0f9afcb..41f8e655b 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ If you ever have any problems, questions, or ideas, the maintainers of this proj [Apollo](https://apollographql.com/) builds open-source software and a graph platform to unify GraphQL across your apps and services. We help you ship faster with: -* [GraphOS Studio](https://www.apollographql.com/studio/develop/) – A free, end-to-end platform for managing your GraphQL lifecycle. Track your GraphQL schemas in a hosted registry to create a source of truth for everything in your graph. Studio provides an IDE (Apollo Explorer) so you can explore data, collaborate on queries, observe usage, and safely make schema changes. +* [GraphOS](https://www.apollographql.com/docs/graphos) – A free, end-to-end platform for managing your GraphQL lifecycle. Track your GraphQL schemas in a hosted registry to create a source of truth for everything in your graph. GraphOS provides an IDE (Apollo Explorer) so you can explore data, collaborate on queries, observe usage, and safely make schema changes. * [Apollo Federation](https://www.apollographql.com/apollo-federation) – The industry-standard open architecture for building a distributed graph. Use Apollo’s to compose a unified graph from multiple subgraphs, determine a query plan, and route requests across your services. * [Apollo Client](https://www.apollographql.com/apollo-client/) – The most popular GraphQL client for the web. Apollo also builds and maintains [Apollo iOS](https://github.com/apollographql/apollo-ios) and [Apollo Android](https://github.com/apollographql/apollo-android). * [Apollo Server](https://www.apollographql.com/docs/apollo-server/) – A production-ready JavaScript GraphQL server that connects to any microservice, API, or database. Compatible with all popular JavaScript frameworks and deployable in serverless environments. diff --git a/docs/source/config.json b/docs/source/config.json index dece85016..3864b6559 100644 --- a/docs/source/config.json +++ b/docs/source/config.json @@ -14,7 +14,7 @@ "Introduction": "/", "Quickstart": { "Project setup": "/quickstart/setup", - "Composition in Apollo Studio": "/quickstart/studio-composition", + "Composition in GraphOS Studio": "/quickstart/studio-composition", "Local composition": "/quickstart/local-composition", "Working with subgraphs": "/quickstart/local-subgraphs" }, diff --git a/docs/source/migrating-from-stitching.md b/docs/source/migrating-from-stitching.md index 9c0426d24..770968cb4 100644 --- a/docs/source/migrating-from-stitching.md +++ b/docs/source/migrating-from-stitching.md @@ -69,11 +69,11 @@ There are [several community-contributed packages](./building-supergraphs/suppor We strongly recommend that you register all of your GraphQL schemas with an [external registry](https://principledgraphql.com/integrity#3-track-the-schema-in-a-registry). This registry supports running the gateway with the subgraphs' partial schemas. Additionally, it enables tracking changes at the subgraph level and protecting the graph from changes that break composition. -[GraphOS Studio](https://www.apollographql.com/docs/studio/) provides a free schema registry that helps you manage your federated gateway's configuration. You provide your gateway a Studio API key on startup, which directs the gateway to download your schemas automatically in a fault-tolerant way. +[GraphOS](/graphos#whats-in-graphos) provides a free schema registry that helps you manage your federated gateway's configuration. You provide your gateway a Studio API key on startup, which directs the gateway to download your schemas automatically in a fault-tolerant way. -Studio can also provide [schema validation](https://www.apollographql.com/docs/studio/managed-federation/overview/#validating-changes-to-the-graph) to ensure that all changes you make to your subgraphs are compatible with your complete graph. +GraphOS can also provide [schema validation](/graphos/delivery/schema-checks/) to ensure that all changes you make to your subgraphs are compatible with your complete graph. -[Learn more about managed configuration.](https://www.apollographql.com/docs/studio/managed-federation/overview/) +[Learn more about managed configuration.](./managed-federation/overview) ## Step 3: Start up an Apollo Server gateway @@ -81,7 +81,7 @@ After you've registered your schemas, you can start exposing your subgraphs from We recommend setting up the Apollo Server gateway alongside your existing schema-stitching gateway. Depending on your infrastructure, you might even want to run both in the same process to support dynamically routing traffic through one gateway or the other. -To enable managed configuration with GraphOS Studio, set the `APOLLO_KEY` and `APOLLO_GRAPH_REF` environment variables when you start up your Apollo Server gateway, and do not provide the `supergraphSDL` or `serviceList` constructor option to `ApolloGateway`. For details, see the [GraphOS Studio documentation](https://www.apollographql.com/docs/studio/managed-federation/setup/). +To enable managed configuration with GraphOS Studio, set the `APOLLO_KEY` and `APOLLO_GRAPH_REF` environment variables when you start up your Apollo Server gateway, and do not provide the `supergraphSDL` or `serviceList` constructor option to `ApolloGateway`. For details, see the [managed federation documentation](./managed-federation/overview). After your gateway is set up, you can make direct queries to it that are routed to the correct subgraphs. diff --git a/docs/source/performance/monitoring.mdx b/docs/source/performance/monitoring.mdx index 1132fc9f5..232a40add 100644 --- a/docs/source/performance/monitoring.mdx +++ b/docs/source/performance/monitoring.mdx @@ -11,9 +11,9 @@ This article describes Apollo managed federation features that help you monitor Federated graphs can push operation metrics to GraphOS Studio to enable many powerful tools, including: -* Operation performance dashboards -* [Schema checks](https://www.apollographql.com/docs/studio/schema-checks/) -* [Performance alerts](https://www.apollographql.com/docs/studio/performance-alerts/) (paid and experimental) +* [Operation performance dashboards](/graphos/metrics/operations) +* [Schema checks](/graphos/delivery/schema-checks/) +* [Performance alerts](/graphos/metrics/notifications/performance-alerts) (paid and experimental) With a federated graph, your subgraphs pass _trace data_ (timing and error information for each resolved schema field) to the gateway for every operation. The gateway then pushes that data to Studio: diff --git a/docs/source/quickstart/setup.mdx b/docs/source/quickstart/setup.mdx index 92244d3f1..f0213fc05 100644 --- a/docs/source/quickstart/setup.mdx +++ b/docs/source/quickstart/setup.mdx @@ -154,7 +154,7 @@ Let's set these up first! Before we can use managed federation with GraphOS Studio, we need a Studio account. Let's create one if you don't have one yet. -Complete the first two steps of Get started with GraphOS Studio (**Create your account** and **Create your first graph**), then return here. +Complete the first two steps of [Get started with GraphOS Studio](/graphos/quickstart/cloud) (**Create your account** and **Create your first graph**), then return here. diff --git a/docs/source/quickstart/studio-composition.mdx b/docs/source/quickstart/studio-composition.mdx index 3560faeca..79c3cb020 100644 --- a/docs/source/quickstart/studio-composition.mdx +++ b/docs/source/quickstart/studio-composition.mdx @@ -109,7 +109,7 @@ API keys are secret credentials. Never share them outside your organization or c -1. Obtain a graph API key for your Studio graph by following these steps. If you have an Enterprise plan, set the API key's role to **Contributor**. +1. Obtain a graph API key for your Studio graph by following these steps. If you have an Enterprise plan, set the API key's role to **Contributor**. - Make sure to copy and paste the API key's value somewhere so you can reference it (for security, API keys are not visible in Studio after creation).