Skip to content

Commit

Permalink
Disclose production differences in Getting Started.
Browse files Browse the repository at this point in the history
While #3300 did correctly make the adjustments that are necessary when
someone's getting started experience involves a deployed version of the
application (for example, if you're deploying your Getting Started
application to Zeit's Now), the additional parameters are not otherwise
necessary.  In fact, introducing them may inadvertently cause users to
enable these, when we intentionally take the step to disable it.

This seems like an alternative approach that seems like it should hopefully
still help explain that nuance, while addressing the concern about it
becoming the de-facto copy-paste approach. :)

Cc: @trevor-scheer
Co-authored-by: Alex Homer <[email protected]>
Ref: #3300 (comment)
Closes: #3300
  • Loading branch information
abernix and realalexhomer committed Oct 8, 2019
1 parent 6a4b681 commit e548a8c
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/source/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,12 @@ We're up and running!
We can now execute GraphQL queries on our server. To execute our first query,
we'll use a tool called **GraphQL Playground**.

> **Note:** If your server is deployed to an environment where `NODE_ENV` is
> set to `production`, GraphQL Playground and introspection will be disabled by
> default. To enable them, you'll need to explicitly set `playground: true` and
> `introspection: true` within [the options to `ApolloServer`'s
> constructor](https://www.apollographql.com/docs/apollo-server/api/apollo-server/#apolloserver).
With your server still running, visit `http://localhost:4000` in your browser
to open GraphQL Playground. (Apollo Server hosts GraphQL Playground automatically
when you run it in development.)
Expand Down

0 comments on commit e548a8c

Please sign in to comment.