Skip to content

Commit

Permalink
Merge pull request #7501 from apollographql/sb/docs-link-fixes
Browse files Browse the repository at this point in the history
Update docs links
  • Loading branch information
Stephen Barlow committed Apr 11, 2023
2 parents 3307b72 + cae8533 commit 8101896
Show file tree
Hide file tree
Showing 11 changed files with 13 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/source/api/apollo-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ This field is helpful if:

<td>

You can use this field to integrate your server with [Apollo Gateway](/federation/api/apollo-gateway/).
You can use this field to integrate your server with [Apollo Gateway](../using-federation/api/apollo-gateway/).

</td>
</tr>
Expand Down
4 changes: 2 additions & 2 deletions docs/source/api/plugin/landing-pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ In non-production environments, Apollo Server 4's landing page is an embedded ve

This landing page is designed for use in local development, where `NODE_ENV` is *not* set to `production`.

[Apollo Sandbox](https://studio.apollographql.com/sandbox) is a special mode of Apollo Studio used for local development, which doesn't require an Apollo account. Sandbox includes the [Apollo Studio Explorer](/graphos/explorer/explorer), a powerful web IDE that enables you to build and run operations against your server (or any other reachable server).
[Apollo Sandbox](https://studio.apollographql.com/sandbox) is a special mode of Apollo Studio used for local development, which doesn't require an Apollo account. Sandbox includes the [Apollo Studio Explorer](/graphos/explorer/), a powerful web IDE that enables you to build and run operations against your server (or any other reachable server).
### Options

<table class="field-table">
Expand Down Expand Up @@ -323,7 +323,7 @@ The `ApolloServerPluginLandingPageProductionDefault` shows a minimalist landing

<img class="screenshot" src="../../images/as-landing-page-production.jpg" alt="Apollo Server default landing page" width="350"/>

This landing page is designed for use in production. It provides a copyable command-line snippet showing how to run operations with your server. By default, the only visible reference to Apollo is a footer explaining how to customize the page. You can also configure it to add a link to query your graph with the [Apollo Explorer](/graphos/explorer/explorer/). You can choose to embed the Apollo Explorer on your endpoint if you pass the `embed` [option](#embed-options).
This landing page is designed for use in production. It provides a copyable command-line snippet showing how to run operations with your server. By default, the only visible reference to Apollo is a footer explaining how to customize the page. You can also configure it to add a link to query your graph with the [Apollo Explorer](/graphos/explorer/). You can choose to embed the Apollo Explorer on your endpoint if you pass the `embed` [option](#embed-options).

### Options

Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/plugin/usage-reporting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "API Reference: Usage reporting plugin"
api_reference: true
---

Apollo Server's built-in usage reporting plugin gathers data on how your clients use the operations and fields in your GraphQL schema. The plugin also handles pushing this usage data to [Apollo Studio](/studio/), as described in [Metrics and logging](../../monitoring/metrics/).
Apollo Server's built-in usage reporting plugin gathers data on how your clients use the operations and fields in your GraphQL schema. The plugin also handles pushing this usage data to [GraphOS](/graphos/), as described in [Metrics and logging](../../monitoring/metrics/).

This plugin is designed to be used in an Apollo Gateway or in a monolithic server; it is not designed to be used from a subgraph. In a supergraph running Apollo Federation, the Apollo Gateway or Apollo Router will send usage reports to Apollo's cloud. Subgraphs don't need to also send usage reports to Apollo's cloud; instead, they send it to the Router via [inline traces](./inline-trace/) and the Router combines execution information across all subgraphs and sends summarized reports to the cloud.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/builtin-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You can also [create custom plugins](./integrations/plugins/).

| Name | Description | Location |
|------|---------|-------------|
| [Usage reporting](./api/plugin/usage-reporting/) | Gathers helpful operation usage data and reports it to [Apollo Studio](https://www.apollographql.com/docs/studio/) for visualization, alerting, and more. |`@apollo/server/plugin/usageReporting` |
| [Usage reporting](./api/plugin/usage-reporting/) | Gathers helpful operation usage data and reports it to [GraphOS](/graphos/) for visualization, alerting, and more. |`@apollo/server/plugin/usageReporting` |
| [Schema reporting](./api/plugin/schema-reporting/) | Automatically reports the server's schema to [Apollo Studio](/studio/) on startup to enable schema history and up-to-date metrics. | `@apollo/server/plugin/schemaReporting` |
| [Inline trace](./api/plugin/inline-trace/) | Used primarily by [federated subgraphs](https://www.apollographql.com/docs/federation/) to include operation trace data in responses to the gateway. | `@apollo/server/plugin/inlineTrace` |
| [Cache control](./api/plugin/cache-control/) | Calculates caching behavior for operation responses. | `@apollo/server/plugin/cacheControl` |
Expand Down
2 changes: 1 addition & 1 deletion docs/source/data/fetching-data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ export class ReservationsDataSource {

If you want to add batching, deduplication, or caching to your data source class, we recommend using the [DataLoader package](https://github.com/graphql/dataloader). Using a package like DataLoader is particularly helpful for solving the [infamous N+1 query problem](https://shopify.engineering/solving-the-n-1-problem-for-graphql-through-batching).

DataLoader provides a memoization cache, which avoids loading the same object multiple times during a single GraphQL request ([much like one of `RESTDataSource`'s caching layers](./fetching-rest#get-requests-and-responses)). It also combines loads during a single event loop tick into a batched request that fetches multiple objects at once.
DataLoader provides a memoization cache, which avoids loading the same object multiple times during a single GraphQL request ([much like one of `RESTDataSource`'s caching layers](./fetching-rest#get-and-head-requests-and-responses)). It also combines loads during a single event loop tick into a batched request that fetches multiple objects at once.

DataLoader instances are per-request, so if you use a DataLoader in your data source, ensure you **create a new instance of that class with every request** :

Expand Down
2 changes: 1 addition & 1 deletion docs/source/data/subscriptions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -610,7 +610,7 @@ If you intend to [switch from `subscriptions-transport-ws` to `graphql-ws`](/apo
<tr>
<td>

[Apollo Studio Explorer](/graphos/explorer/explorer/)
[Apollo Studio Explorer](/graphos/explorer/)

</td>

Expand Down
3 changes: 1 addition & 2 deletions docs/source/deployment/lambda.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ If successful, `serverless` should output something like this:
> Monitor all your API routes with Serverless Console: run "serverless --console"
```

You can now navigate to your endpoints and query your newly hosted server using [Apollo Sandbox](/studio/explorer/sandbox).
You can now navigate to your endpoints and query your newly hosted server using [Apollo Sandbox](/graphos/explorer/sandbox/).

#### What does `serverless` do?

Expand Down Expand Up @@ -538,4 +538,3 @@ exports.graphqlHandler = serverlessExpress({ app });
</MultiCodeBlock>

The setup enables you to customize your HTTP behavior as needed.

2 changes: 1 addition & 1 deletion docs/source/migration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1003,7 +1003,7 @@ For `ValidationError`, use `ApolloServerErrorCode.GRAPHQL_VALIDATION_FAILED`. Fo
### `__resolveObject`

Apollo Server 4 removes the dependency on `@apollographql/apollo-tooling`, additionally removing the `__resolveObject` pseudo-resolver. The `__resolveObject` function was an undocumented predecessor to
the [`__resolveReference`](/federation/api/apollo-subgraph/#__resolvereference) method. While we believe `__resolveObject` is a useful feature, it would work better if implemented directly in `graphql-js` rather than in Apollo Server.
the [`__resolveReference`](./using-federation/api/apollo-subgraph/#__resolvereference) method. While we believe `__resolveObject` is a useful feature, it would work better if implemented directly in `graphql-js` rather than in Apollo Server.

### `requestAgent` option to `ApolloServerPluginUsageReporting`

Expand Down
4 changes: 2 additions & 2 deletions docs/source/monitoring/metrics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ Apollo Server integrates seamlessly with [Apollo GraphOS](/graphos/) to help you
## Sending metrics to GraphOS

[Apollo GraphOS](/graphos/) provides an integrated hub for all of your GraphQL performance data, which you can view in Apollo Studio. Studio [aggregates and displays information](/graphos/metrics/usage-reporting/) for your schema, queries, requests, and errors. You can also configure alerts that support [Slack](/graphos/notifications/notification-setup/#slack) and [Datadog](/graphos/metrics/datadog-integration/) integrations.
[Apollo GraphOS](/graphos/) provides an integrated hub for all of your GraphQL performance data, which you can view in Apollo Studio. Studio [aggregates and displays information](/graphos/metrics/) for your schema, queries, requests, and errors. You can also configure alerts that support [Slack](/graphos/metrics/notifications/notification-setup/#slack) and [Datadog](/graphos/metrics/datadog-integration/) integrations.

### Connecting to GraphOS

To connect Apollo Server to GraphOS, first [obtain a graph API key](/graphos/api-keys#graph-api-keys). To provide this key to Apollo Server, assign it to the `APOLLO_KEY` environment variable in your server's environment.

Then associate your server instance with a particular graph ID and [graph variant](/graphos/graphs/overview/#variants) by setting the `APOLLO_GRAPH_REF` environment variable.
Then associate your server instance with a particular graph ID and [graph variant](/graphos/graphs/#variants) by setting the `APOLLO_GRAPH_REF` environment variable.

You can set environment variable values on the command line as seen below, or with the [`dotenv` npm package](https://www.npmjs.com/package/dotenv) (or similar).

Expand Down
3 changes: 1 addition & 2 deletions docs/source/using-federation/apollo-subgraph-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Implementing a subgraph with Apollo Server

This article demonstrates how to create a **subgraph** for a federated supergraph using Node.js and Apollo Server.

> To create a subgraph using a different language and/or framework, see the list of [Federation-compatible subgraph implementations](/federation/supported-subgraphs/). Note that not all listed libraries support _all_ Federation features.
> To create a subgraph using a different language and/or framework, see the list of [Federation-compatible subgraph implementations](/federation/building-supergraphs/supported-subgraphs/). Note that not all listed libraries support _all_ Federation features.
## Defining a subgraph

Expand Down Expand Up @@ -241,4 +241,3 @@ console.log(`馃殌 Server ready at ${url}`);
## Custom directives

See [Custom directives in subgraphs](../schema/directives/#in-subgraphs).

2 changes: 1 addition & 1 deletion docs/source/workflow/build-run-queries.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ In non-production environments, Apollo Server 4's landing page is an embedded ve

> Apollo Server serves a different landing page [in production](#production-vs-non-production).
[Apollo Sandbox](https://studio.apollographql.com/sandbox) is a special mode of Apollo Studio used for local development, which doesn't require an Apollo account. Sandbox includes the [Apollo Studio Explorer](/graphos/explorer/explorer), a powerful web IDE that enables you to build and run operations against your server (or any other reachable server).
[Apollo Sandbox](https://studio.apollographql.com/sandbox) is a special mode of Apollo Studio used for local development, which doesn't require an Apollo account. Sandbox includes the [Apollo Studio Explorer](/graphos/explorer/), a powerful web IDE that enables you to build and run operations against your server (or any other reachable server).

## Production vs. non-production

Expand Down

0 comments on commit 8101896

Please sign in to comment.