Skip to content

Commit

Permalink
docs: add redirect and update links (#3089)
Browse files Browse the repository at this point in the history
Add redirect for subgraph compatibility page
  • Loading branch information
Meschreiber authored Jul 17, 2024
1 parent ed9561c commit f91cbd7
Show file tree
Hide file tree
Showing 11 changed files with 13 additions and 12 deletions.
1 change: 1 addition & 0 deletions docs/source/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
/gateway/ /docs/federation/building-supergraphs/router/
/router/ /docs/federation/building-supergraphs/router/
/supported-subgraphs/ /docs/federation/building-supergraphs/compatible-subgraphs/
/building-supergraphs/supported-subgraphs/ /docs/federation/building-supergraphs/compatible-subgraphs/
/other-servers/ /docs/federation/building-supergraphs/compatible-subgraphs/
/federation-spec/ /docs/federation/subgraph-spec/
/building-supergraphs/subgraphs-apollo-server/ /docs/apollo-server/using-federation/apollo-subgraph-setup/
Expand Down
2 changes: 1 addition & 1 deletion docs/source/building-supergraphs/subgraphs-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You can implement different subgraphs using completely different programming lan

Every subgraph in your supergraph should use a subgraph-compatible GraphQL server library. These are libraries that adhere to the Apollo Federation subgraph specification, which ensures that your supergraph can take full advantage of federation features like [entities](../entities/).

[See federation-compatible subgraph libraries.](./supported-subgraphs/)
[See federation-compatible subgraph libraries.](./compatible-subgraphs/)

After you select a subgraph library, consult its documentation to learn how to configure it to run as a subgraph.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/entities.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ The `@key` directive effectively tells the router, "This subgraph can resolve an

<Note>

This section describes how to create reference resolvers in Apollo Server. If you're using another [subgraph-compatible library](./building-supergraphs/supported-subgraphs/), see its documentation for creating reference resolvers (or the equivalent functionality).
This section describes how to create reference resolvers in Apollo Server. If you're using another [subgraph-compatible library](./building-supergraphs/compatible-subgraphs/), see its documentation for creating reference resolvers (or the equivalent functionality).

</Note>

Expand Down
4 changes: 2 additions & 2 deletions docs/source/federated-types/federated-directives.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ type Product @key(fields: "upc") @key(fields: "sku") {

<Note>

To check whether your subgraph library supports repeatable directives, see the `repeatable @key` item in [Federation-compatible subgraph implementations](../building-supergraphs/supported-subgraphs/).
To check whether your subgraph library supports repeatable directives, see the `repeatable @key` item in [Federation-compatible subgraph implementations](../building-supergraphs/compatible-subgraphs/).

</Note>

Expand Down Expand Up @@ -874,7 +874,7 @@ directive @hello on FIELD_DEFINITION

This directive has the following requirements:

- Ensure your [subgraph library](../building-supergraphs/supported-subgraphs) supports `@composeDirective` or try manually adding the `@composeDirective` definition to your subgraph schema.
- Ensure your [subgraph library](../building-supergraphs/compatible-subgraphs) supports `@composeDirective` or try manually adding the `@composeDirective` definition to your subgraph schema.
- The directive to preserve must be defined and imported from a core specification via the `@link` directive.
- The specified directive `name` must match the name used for the directive in this subgraph.
- If you use the `as` argument in your `@link` definition to modify the directive's name from its spec's default, provide the modified name, not the default name.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/federated-types/interfaces.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ As it does with any [standard entity](../entities/#1-define-a-key), `@key` indic

<Note>

The method for defining a reference resolver depends on which [subgraph library](../building-supergraphs/supported-subgraphs/) you use. Some subgraph libraries might use a different term for this functionality. Consult your library's documentation for details.
The method for defining a reference resolver depends on which [subgraph library](../building-supergraphs/compatible-subgraphs/) you use. Some subgraph libraries might use a different term for this functionality. Consult your library's documentation for details.

</Note>

Expand Down
4 changes: 2 additions & 2 deletions docs/source/federation-2/moving-to-federation-2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ To use new Federation 2 features and their associated directives, it's helpful t
npm install @apollo/subgraph
```

- If your subgraph uses another server library, check the [compatibility table](../building-supergraphs/supported-subgraphs/) to see whether it supports Federation 2 directives yet. If it does, consult that library's documentation to determine which version you need to update to.
- If your subgraph uses another server library, check the [compatibility table](../building-supergraphs/compatible-subgraphs/) to see whether it supports Federation 2 directives yet. If it does, consult that library's documentation to determine which version you need to update to.
- If your library doesn't support Federation 2 directives yet, you can still use that library with Federation 2 if the library lets you add custom directive definitions to your schema!

### Opt in to Federation 2
Expand All @@ -209,7 +209,7 @@ Depending on your schema, you might need to add other federated directives to th

### Add directive definitions if needed

Currently, not all [subgraph libraries](../building-supergraphs/supported-subgraphs/) provide built-in support for Federation 2 directives (such as `@shareable`). If your library doesn't provide this support, you need to add the following directive definitions to your subgraph schema:
Currently, not all [subgraph libraries](../building-supergraphs/compatible-subgraphs/) provide built-in support for Federation 2 directives (such as `@shareable`). If your library doesn't provide this support, you need to add the following directive definitions to your subgraph schema:

<ExpansionPanel title="Click to expand">

Expand Down
2 changes: 1 addition & 1 deletion docs/source/federation-2/new-in-federation-2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Before covering what's new, here's what isn't changing in Federation 2:
* Graphs that do require changes are graphs that should cause composition errors, but Federation 1 fails to detect them. [Learn more.](./backward-compatibility/#do-i-need-to-modify-my-subgraph-schemas-to-use-federation-2)
* To take full advantage of Federation 2 features, you do need to make some changes to your subgraph schemas, but you can make these changes incrementally at your convenience. See [Moving to Apollo Federation 2](./moving-to-federation-2/).

* Subgraph servers have no additional requirements. Any [subgraph-compatible library](../building-supergraphs/supported-subgraphs/) is automatically compatible with Federation 2.
* Subgraph servers have no additional requirements. Any [subgraph-compatible library](../building-supergraphs/compatible-subgraphs/) is automatically compatible with Federation 2.
* Many subgraph-compatible libraries do not yet automatically define certain directives that are new in Federation 2, such as `@shareable`. You can [define these directives manually](./moving-to-federation-2/#add-directive-definitions-if-needed) to use them in your subgraph schemas.

## More flexible composition
Expand Down
2 changes: 1 addition & 1 deletion docs/source/federation-versions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ For a comprehensive changelog for Apollo Federation and its associated libraries

</Note>

- If you maintain a [subgraph-compatible library](./building-supergraphs/supported-subgraphs/), consult this article to stay current with recently added directives. All of these directive definitions are also listed in the [subgraph specification](./subgraph-spec/#subgraph-schema-additions).
- If you maintain a [subgraph-compatible library](./building-supergraphs/compatible-subgraphs/), consult this article to stay current with recently added directives. All of these directive definitions are also listed in the [subgraph specification](./subgraph-spec/#subgraph-schema-additions).

## v2.8

Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ graph LR;
class clients secondary;
```

Different subgraphs in the same supergraph can use different server implementations and even different programming languages as long as they are [federation-compatible](./building-supergraphs/supported-subgraphs/).
Different subgraphs in the same supergraph can use different server implementations and even different programming languages as long as they are [federation-compatible](./building-supergraphs/compatible-subgraphs/).

<Tip>

Expand Down
2 changes: 1 addition & 1 deletion docs/source/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ To complete this quickstart, you must have the following:

<Note>

While the retail demo uses Node.js for all its services, Apollo Federation is compatible with [many GraphQL server libraries](./building-supergraphs/supported-subgraphs).
While the retail demo uses Node.js for all its services, Apollo Federation is compatible with [many GraphQL server libraries](./building-supergraphs/compatible-subgraphs).
You can also federate services that use different programming languages and different server libraries.

</Note>
Expand Down
2 changes: 1 addition & 1 deletion docs/source/subgraph-spec.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ subtitle: Subgraph specification reference for server library developers
description: Learn about Apollo Federation 2 subgraph specifications, enhanced introspection, and entity field resolution for GraphQL server libraries.
---

This content is provided for developers adding federated subgraph support to a GraphQL server library, and for anyone curious about the inner workings of federation. You do not need to read this if you're building a supergraph with existing [subgraph-compatible libraries](./building-supergraphs/supported-subgraphs/), such as Apollo Server.
This content is provided for developers adding federated subgraph support to a GraphQL server library, and for anyone curious about the inner workings of federation. You do not need to read this if you're building a supergraph with existing [subgraph-compatible libraries](./building-supergraphs/compatible-subgraphs/), such as Apollo Server.

Servers that are partially or fully compatible with this specification are tracked in Apollo's [subgraph compatibility repository](https://github.com/apollographql/apollo-federation-subgraph-compatibility).

Expand Down

0 comments on commit f91cbd7

Please sign in to comment.