apollographql / graphql-subscriptions

:newspaper: A small module that implements GraphQL subscriptions for Node.js
MIT License
1.59k stars 133 forks source link

documentation is out-of-date or wrong #182

Open jrhite opened 5 years ago

jrhite commented 5 years ago

The documentation seems to be very out-of-date everywhere I look. Here are some examples:

The GitHub readme at subscriptions-transport-ws makes reference to a functions graphqlExpress() and graphiqlExpress(). These functions don't seem to exist anymore, nor be the proper way to go. From what I can tell the new way to go about this is something like:

const app = express();
const apolloServer = new ApolloServer(...);
apolloServer.applyMiddleware({ app });
...

The docs at graphql-subscriptions also makes references to graphqlExpress() and graphiqlExpress(). Further, these docs link to a tutorial on Medium which also reference graphqlExpress() and graphiqlExpress().

I feel like I'm feeling my way through the dark on this and not sure which docs to trust and they all seem consistently wrong and/or out-of-date.

grantwwu commented 5 years ago

I think a lot of those still reference Apollo Server 1. Apollo Server 2 seems to have drastically changed a lot of things: https://www.apollographql.com/docs/apollo-server/migration-two-dot.html

I'm really short on bandwidth, but PRs accepted.