Docs improvements round 2 (#693)

* Add 1.0 migration article, belated

* Add tracing + cache control to sidebar

* Suggest graphql-tools

* Link to graphql-tools in README

* Wording

* Try a new title

* Add example to top
This commit is contained in:
Sashko Stubailo 2017-12-11 23:44:32 -08:00 committed by GitHub
parent 93f052352c
commit 62158acbd1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 37 additions and 8 deletions

View file

@ -6,7 +6,7 @@ Also supports: Restify, Micro, Azure Functions, AWS Lambda and Adonis Framework
[![Build Status](https://travis-ci.org/apollographql/apollo-server.svg?branch=master)](https://travis-ci.org/apollographql/apollo-server)
[![Get on Slack](https://img.shields.io/badge/slack-join-orange.svg)](https://www.apollographql.com/#slack)
Apollo Server is a community-maintained open-source GraphQL server. It works with pretty much all Node.js HTTP server frameworks, and we're happy to take PRs for more! It works with any GraphQL schema built with the [`graphql-js` reference implementation](https://github.com/graphql/graphql-js).
Apollo Server is a community-maintained open-source GraphQL server. It works with pretty much all Node.js HTTP server frameworks, and we're happy to take PRs for more! Apollo Server works with any GraphQL schema built with [GraphQL.js](https://github.com/graphql/graphql-js), so you can build your schema with that directly or with a convenience library such as [graphql-tools](https://www.apollographql.com/docs/graphql-tools/).
## Documentation

View file

@ -28,14 +28,19 @@ sidebar_categories:
- servers/restify
- servers/azure-functions
- servers/adonis
Migration:
- migration-hapi
- migration
Related:
- title: graphql-tools
href: https://www.apollographql.com/docs/graphql-tools/
- title: GraphQL Subscriptions
href: https://www.apollographql.com/docs/graphql-subscriptions/
- title: Apollo Tracing
href: https://github.com/apollographql/apollo-tracing-js
- title: Apollo Cache Control
href: https://github.com/apollographql/apollo-cache-control-js
Migration:
- migration-one-dot
- migration-hapi
- migration
github_repo: apollographql/apollo-server
content_root: docs/source

View file

@ -1,12 +1,14 @@
---
title: Apollo Server
title: Build a GraphQL server with Node.js
sidebar_title: Installing
description: Flexible, community driven, production-ready HTTP GraphQL middleware for Node.js. Supports Express, Connect, Hapi, Koa, and more.
description: Apollo Server is a flexible, community driven, production-ready HTTP GraphQL middleware for Node.js.
---
Apollo Server works with any GraphQL schema built with [GraphQL.js](https://github.com/graphql/graphql-js), Facebook's reference JavaScript execution library, and you can use Apollo Server with all popular JavaScript HTTP servers, including Express, Connect, Hapi, Koa, Restify, and Lambda.
Apollo Server is a library that helps you connect a GraphQL schema to an HTTP server in Node. If you want to get started quickly, take a look at the [end-to-end example](./example.html).
This server can be queried from any popular GraphQL client, such as [Apollo](https://www.apollographql.com/client/) or [Relay](https://facebook.github.io/relay) because it supports all of the common semantics for sending GraphQL over HTTP, as [documented on graphql.org](http://graphql.org/learn/serving-over-http/). Apollo Server also supports some small extensions to the protocol, such as sending multiple GraphQL operations in one request. Read more on the [sending requests](/tools/apollo-server/requests.html) page.
Apollo Server works with any GraphQL schema built with [GraphQL.js](https://github.com/graphql/graphql-js), so you can build your schema with that directly or with a convenience library such as [graphql-tools](https://www.apollographql.com/docs/graphql-tools/). You can use Apollo Server with all popular JavaScript HTTP servers, including Express, Connect, Hapi, Koa, Restify, and Lambda.
This server can be queried from any GraphQL client, since it supports all of the common semantics for sending GraphQL over HTTP, as [documented on graphql.org](http://graphql.org/learn/serving-over-http/). Apollo Server also supports some small extensions to the protocol, such as sending multiple GraphQL operations in one request. Read more on the [sending requests](/tools/apollo-server/requests.html) page.
<h2 id="selecting-package">Selecting the right package</h2>

View file

@ -0,0 +1,22 @@
---
title: Migrating to v1.0
description: How to migrate to Apollo Server 1.0
---
In July of 2017, we [announced the release of Apollo Server 1.0](https://dev-blog.apollodata.com/apollo-server-1-0-a-graphql-server-for-all-node-js-frameworks-2b37d3342f7c). This was not a major change, except for one thing: All of the packages have been renamed from `graphql-server-*` to `apollo-server-*`.
All of the options, names, and API are identical to pre-1.0 versions.
So, if before you were doing:
```js
import { graphqlExpress, graphiqlExpress } from 'graphql-server-express';
```
Now, you should do:
```js
import { graphqlExpress, graphiqlExpress } from 'apollo-server-express';
```
We made this change because it was consistent with how developers in the community were referring to the package. With the `graphql-server` name, we wanted to emphasize that this package works with any GraphQL technology, but people called it "Apollo Server" anyway, so we decided that was a good name to use officially as well.