Skip to content

Commit

Permalink
docs: update quickstart (#3037)
Browse files Browse the repository at this point in the history
  • Loading branch information
Meschreiber authored Jun 24, 2024
1 parent eb81831 commit 520f5cb
Show file tree
Hide file tree
Showing 15 changed files with 597 additions and 901 deletions.
7 changes: 1 addition & 6 deletions docs/source/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,8 @@
],
"sidebar": {
"Introduction": "/",
"Quickstart": "/quickstart",
"Changelog": "/federation-versions",
"Quickstart": {
"Project Setup": "/quickstart/setup",
"Composition in GraphOS Studio": "/quickstart/studio-composition",
"Local Composition": "/quickstart/local-composition",
"Working with Subgraphs": "/quickstart/local-subgraphs"
},
"Building Your Supergraph": {
"Subgraphs": "/building-supergraphs/subgraphs-overview",
"Supported Subgraph Libraries": "/building-supergraphs/supported-subgraphs",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/images/quickstart/get-cart.jpg
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.
Binary file added docs/source/images/quickstart/query-plan.jpg
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.
Binary file added docs/source/images/quickstart/schema-sdl.jpg
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.
8 changes: 7 additions & 1 deletion docs/source/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ graph LR;
class clients secondary;
```

<Tip>

To jump into building a federated GraphQL API, check out the [Apollo Federation Quickstart](./quickstart).

</Tip>

## Benefits of federation

### Microservices architecture
Expand Down Expand Up @@ -149,8 +155,8 @@ Depending on your goals, you have several options for learning more about federa

Once you're ready to apply federation to your own APIs, these docs sections can help you get started:

- [Quickstart](./quickstart) to get you up and running with a federated graph
- Conceptual overview of [Federated Schemas](./federated-types/overview)
- [Guide on using Apollo GraphOS](./managed-federation/overview) to automate and manage deployments of your federated schemas (this is also known as _managed federation_)
- Reference materials for:
- [Performance considerations](./performance/caching)
- [Debugging and metrics](./errors)
Expand Down
Loading

0 comments on commit 520f5cb

Please sign in to comment.