Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for [email protected] is wrong #1216

Closed
tpetry opened this issue Jun 21, 2018 · 3 comments
Closed

Documentation for [email protected] is wrong #1216

tpetry opened this issue Jun 21, 2018 · 3 comments
Labels
📝 documentation Focuses on changes to the documentation (docs)

Comments

@tpetry
Copy link

tpetry commented Jun 21, 2018

The documentation for [email protected] is wrong as it's not possible to create a server because both (different) documentations are incorrect:

  • apollo-server README.md: The functions graphqlExpress and graphiqlExpressare no longer exported from apollo-server-express
  • apollo-server-express README.md: The function registerServer is throwing an error that server.applyMiddleware should be used. But this message can only be found when digging into the source because it's declared with zero parameters preventing compilation.
@ghost ghost added the 📝 documentation Focuses on changes to the documentation (docs) label Jun 21, 2018
@unicodeveloper
Copy link
Contributor

unicodeveloper commented Jun 21, 2018

@tpetry The README files are yet to be updated to the latest versions. Please check the documentation for apollo-server and apollo-server-express here.

Please rely on the documentation site for any functionality you need from these tools. I'll work on getting the READMEs updated to the latest version.

@evans
Copy link
Contributor

evans commented Jun 21, 2018

@tpetry Thank you for letting us know! We're removing the registerServer function in this release and will add it to the documentation. It was just in there for people upgrading from the beta.

@evans
Copy link
Contributor

evans commented Jun 23, 2018

We've fixed the readme's and they will be out for the next release. @tpetry if you find any additional documentation issues, please feel free to open more issues

@evans evans closed this as completed Jun 23, 2018
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 21, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
📝 documentation Focuses on changes to the documentation (docs)
Projects
None yet
Development

No branches or pull requests

3 participants