Skip to content

Commit

Permalink
Merge pull request #7940 from apollographql/version-2-docs-replatform
Browse files Browse the repository at this point in the history
docs: v2 docs update
  • Loading branch information
Meschreiber authored Oct 16, 2024
2 parents 637adf3 + c6ba6ae commit 56e79fb
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 20 deletions.
2 changes: 1 addition & 1 deletion docs/source/deployment/netlify.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Now, make sure you've run `NODE_ENV=development npm run start:lambda`, and navig

*Note - The GraphQL Playground will only run if your `NODE_ENV` is set to `development`. If you don't pass this, or your `NODE_ENV` is set to `production`, you will not see the GraphQL Playground.*

![Local GraphQL Server](../images/graphql.png)
![Local GraphQL Server](../images/graphql-playground.png)

If you can see GraphQL Playground and run a simple query, you've done everything properly. Now, let's add Apollo Client to the frontend.

Expand Down
8 changes: 3 additions & 5 deletions docs/source/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: Introduction to Apollo Server
#### You can use Apollo Server as:

* A stand-alone GraphQL server, including in a serverless environment
* An add-on to your application's existing [Node.js middleware](./integrations/middleware/) (such as Express or Fastify)
* An add-on to your application's existing [Node.js middleware](/apollo-server/v2/integrations/middleware/) (such as Express or Fastify)
* A gateway for a [federated data graph](https://www.apollographql.com/docs/federation/)

#### Apollo Server provides:
Expand All @@ -21,10 +21,8 @@ title: Introduction to Apollo Server

#### Ready to try it out?

import {Link} from 'gatsby';

<div align="center">
<Button as={Link} to="./getting-started/" size="lg">
<ButtonLink href="/apollo-server/v2/getting-started" size="lg">
Get started!
</Button>
</ButtonLink>
</div>
20 changes: 6 additions & 14 deletions docs/source/testing/graphql-playground.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,26 @@ title: GraphQL Playground
description: Visually explore Apollo Server
---

import { Link } from 'gatsby';

<blockquote>

#### 📣 Query your server with Apollo Sandbox

**Apollo Sandbox** provides a special instance of our Explorer IDE that you can use for local development without an Apollo account.

<p style={{"margin-top": "15px", "margin-bottom": "15px"}}>
<Button
<p
style="margin-top:15px; marign-bottom:15px"
>
<ButtonLink
size="lg"
colorScheme="indigo"
as={Link}
to="https://studio.apollographql.com/sandbox/?referrer=docs-content"
isExternal
href="https://studio.apollographql.com/sandbox/?referrer=docs-content"
>
Launch Sandbox
</Button>
</ButtonLink>
</p>

Sandbox automatically attempts to connect to a GraphQL server running at `http://localhost:4000`. Use the box in the top-left to change this URL to any local or remote GraphQL endpoint that's reachable by your browser.

[Learn more about Sandbox.](/graphos/explorer/sandbox)

</blockquote>

## About GraphQL Playground

> ⚠️ **Apollo Server 2's GraphQL playground feature is officially end-of-life as of 31 December 2022 and will no longer receive updates of any kind.**
Expand All @@ -39,8 +33,6 @@ Sandbox automatically attempts to connect to a GraphQL server running at `http:/

In development, Apollo Server enables GraphQL Playground on the same URL as the GraphQL server itself (e.g. `http://localhost:4000/graphql`) and automatically serves the GUI to web browsers. When `NODE_ENV` is set to `production`, GraphQL Playground (as well as introspection) is disabled as a production best-practice.

![GraphQL Playground](../images/graphql-playground.png)

## Configuring Playground

The Apollo Server constructor contains the ability to configure GraphQL Playground with the `playground` configuration option. The options can be found on GraphQL Playground's [documentation](https://github.com/prismagraphql/graphql-playground/#usage).
Expand Down

0 comments on commit 56e79fb

Please sign in to comment.