Commit graph

79 commits

Author SHA1 Message Date
Jesse Rosenberger
a7597913d2
Remove unnecessary --save flags from npm install commands.
While it used to be required to pass the `--save` flag in order to actually
write the dependency to the project's `package.json` file, this is no longer
the case in recent versions of npm.
2019-02-26 11:18:52 +02:00
Kornel Dubieniecki
c03fe79e33 Make gql example consistent and easier to read (#2087)
Hey guys,
I've noticed that some of the gql examples are indented differently than the rest and I think that consistent indentation and formatting makes it easier to read and comprehend.
Let me know what you think, thanks.
2018-12-13 15:55:04 +02:00
Jesse Rosenberger
034383f491
Consistently use parent, rather than root, as first resolver argument.
In an effort to maintain consistency and semantically correct meaning,
this changes (only in documentation and internal Apollo Server tests) the
name of the first argument in resolver signatures to use `parent` rather
than `root`.

While `root` certainly makes sense when the resolver is belonging to the
root `Query` or `Mutation` type, once nested field resolvers begin getting
called, the more semantically correct term would seem to be `parent`.

Since `parent` still makes sense at the root level, and since resolvers
frequently get copied and pasted into more deeply-nested positions, putting
this pattern in place for apps which are just beginning might just help
someone more clearly understand the relationship in the future — without
incorrectly thinking that a nested resolver is accessing the root of the
graph, rather than the parent.
2018-11-16 20:37:26 +02:00
Jesse Rosenberger
c9ed4d9d2e
Apply suggestions from code review
Co-Authored-By: peggyrayzis <peggyrayzis@gmail.com>
2018-11-15 10:17:59 -05:00
Peggy Rayzis
7b5fa198c9 Add schema design guide content to schema essentials 2018-11-14 20:26:51 -05:00
Marcin Jekot
87335b5998 Suggestion: change wording
Fix grammar, and hopefully make the explanation a bit clearer.

It could also be said like this (for a smaller diff) ;-)

"By allowing the consumer of the API to see the full possibilities that an API can *deliver*, developers can"...
2018-10-16 14:01:43 +02:00
0xflotus
e773932545 fixed typos in docs (#1817)
* Update authentication.md

* Update schema-design.md

* Update schema-design.md

* Update heroku.md

* Update lambda.md

* Update server.md
2018-10-15 10:09:25 +03:00
Alexander CherryTea
0b05b5e92e Update data.md (#1794)
That example code crush with error `find is not defined`, because in imports forgot about lodash `find` and `filter`
2018-10-10 17:26:58 +03:00
KarinaDavtyan
17073ed00b docs: update apollo-cache-control link (#1762) 2018-10-10 17:10:58 +03:00
Hugh Willson
dd86fa8a29 Re-enable Typescript esModuleInterop (#1699)
`esModuleInterop` was enabled in
e4164c8892
to help with importing from packages that use default exports.
Those changes were reverted in
https://github.com/apollographql/apollo-server/pull/1210
to work around a few reported issues. Those issues are no longer
relevant, so this commit re-enables `esModuleInterop`, and
updates all default imports to use the more common (standard)
import syntax.
2018-09-21 16:43:33 +03:00
Zak Mandhro
34ece7552b Added description and sample code for enabling SSL 2018-09-01 09:41:13 +02:00
Jesse Rosenberger
85b97b6f0c docs: Correct path for GraphQL Playground. (#1427)
* docs: Correct path for GraphQL Playground.

This corrects the documentation which incorrectly stated that the message on the console would include `http://localhost:4000/graphql`.

While the `/graphql` URL will also serve the GraphQL Playground, it's only working as a by-product of of `/graphql` being included within the (higher) `/` path. (That is to say that `/any-url` would also respond!).

* [squash] Tweak per feedback.

cc @evans
2018-07-30 15:49:25 -07:00
Prosper Otemuyiwa
ca35b9fe1c Docs: Remove all RC references in Apollo Server 2 documentation (#1377)
* Remove rc from getting-started

* Remove rc from migration engine

* Remove RC references from migration 2 dot

* Remove rc references

* Remove RC references and correct spellings

* Remove RC references from Essentials

* Remove all RC references
2018-07-19 12:44:02 -07:00
Jesse Rosenberger
281760b397
docs: Update blog URLs to reference blog.apollographql.com.
This updates all blog URLs in the documentation to use blog.apollographql.com
as the domain, rather than dev-blog.apollodata.com.
2018-07-13 16:39:42 -07:00
Evans Hauser
9b67773337
docs: add callout to install apollo-server-express 2018-06-28 13:24:31 -07:00
Evans Hauser
84f13babcd
docs: add graphql install next to integrations npm install's 2018-06-25 17:11:08 -07:00
Evans Hauser
846579db33
update README's and remove docs for registerServer (fixes #1216) 2018-06-22 17:51:56 -07:00
Evans Hauser
1592c545dc
docs: change beta to release candidate 2018-06-14 23:37:36 -07:00
Evans Hauser
95fe31dbb6 docs: server.listen to app.listen for express examples 2018-06-14 11:57:30 -07:00
Evans Hauser
7ded129726 docs: replace registerServer with applyMiddleware 2018-06-14 11:57:30 -07:00
Evans Hauser
5e59605c1e
docs: remove GraphiQL and old migration guides 2018-06-13 14:02:49 -07:00
Evans Hauser
ba31cf7a44
Integrations export their own ApolloServer (#1161)
* feat: ApolloServer is created and exported by all variants

* docs: add initial docs around exporting ApolloServer

* feat: export gql from integrations

* docs: change apollo-server examples to use express with registerServer

* server: remove registerExpressServer

* core, docs: comment functions, fix api reference, context creation more like middleware args

* docs: fix integrationed typo
2018-06-12 17:46:56 -07:00
Evans Hauser
5b4644fbfd
docs: add missing gql tags and add comments that gql is necessary for apollo-server 2018-06-06 11:21:05 -07:00
Evans Hauser
20a41163c1
docs: remove dead links from essentials data and fix context creation 2018-05-22 17:38:41 -07:00
unicodeveloper
cd7f92a793 refactor code on server essentials page 2018-05-04 16:04:49 -07:00
unicodeveloper
84ce0efa77 Fix server middleware option 2018-05-04 15:45:53 -07:00
Jesse Rosenberger
7c6fb1e537
[wip] fix Server Essentials for new API. 2018-05-04 15:26:53 -07:00
Jesse Rosenberger
591056ec61
Fix introspection and "describing types". 2018-05-02 17:08:30 -07:00
Jesse Rosenberger
c993c69077
docs: [link-removal] Serverless. 2018-05-02 16:53:05 -07:00
Jesse Rosenberger
7871866136
Update info argument to talk about cache control. 2018-05-02 06:58:11 -07:00
Jesse Rosenberger
b882785389
Change link to Promise to Mozilla docs. 2018-05-02 06:55:22 -07:00
Jesse Rosenberger
264c1c6991
Fix spelling of "alway". 2018-05-02 06:53:20 -07:00
Peggy Rayzis
fa2aa2c54c Restructured essentials (#1019)
* Restructured essentials

* Fix broken links
2018-05-02 06:49:49 -07:00
Jesse Rosenberger
011f0063aa
docs: Update links to new schema concepts. 2018-04-30 17:25:30 -07:00
Jesse Rosenberger
761ff92bb8
docs: Iteration from Docs workshop.
* Bury Best Practices, for the time being.
* Bury Schema, but leave it on disk.
* Introduce new Querying section.
* Move "Why Apollo Server?" into "Index".
   * ...to be refined.
* Remove no-longer-helpful "Getting Started" from "Index".

cc @stubailo @evans @peggyrayzis @JakeDawkins @unicodeveloper @jbaxleyiii
2018-04-30 15:36:08 -07:00
Jesse Rosenberger
fe6ee688a2
Merge pull request #985 from apollographql/docs-essentials-data
[Work in Progress] docs: essentials > data
2018-04-30 22:09:28 +03:00
Jesse Rosenberger
e273c35ba7
Merge branch 'docs-overhaul' into docs-essentials-data 2018-04-30 22:05:13 +03:00
Jesse Rosenberger
e85fc6c347
Nits and editorial on earlier content in Schema 2018-04-27 18:18:11 +03:00
Evans Hauser
80e0c30782
docs: add missing ` in essentials/server 2018-04-25 15:25:07 -07:00
Jesse Rosenberger
b6bdfdbbad
docs: Add instruction for applyMiddleware. 2018-04-25 22:15:34 +03:00
Jesse Rosenberger
16e1286259
docs: Add color about app, and where it might be found in existing applications. 2018-04-25 14:05:27 +03:00
Jesse Rosenberger
c1744faec6
docs: Improve "apollo-server/<variant>" explanation. 2018-04-25 14:04:46 +03:00
Jesse Rosenberger
5317483a83
docs: Simplify explanation of graphql. 2018-04-25 14:04:04 +03:00
Jesse Rosenberger
6e98ba57ef
docs: Use gql template literal tag in all examples.
While the `gql` tag is not currently _required_, it does make it easier to
implement additional, development-friendly functionality in the future.

For example, it could avoid the need to question whether a string literal is
actually using Schema Definition Language (SDL) and avoid the need to
look for context clues.

By implementing these suggestions now, we can avoid the need to ask
developers to refactor in the future.
2018-04-25 14:00:33 +03:00
Jesse Rosenberger
8eaa998c43 docs: Essentials / Server (now, with middleware!) 2018-04-25 12:28:32 +03:00
Jake
57b56427dc [WIP] refined data fetching essentials 2018-04-24 12:55:02 -04:00
Jesse Rosenberger
88adbdbe86 Add "Next steps" for consistency with other sections. 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
a2b926fbc0 Remove SCRATCHPAD. 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
9145c5cc6c Fix typo in named operations. 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
ed016762f7 Shorten operation name. 2018-04-24 17:58:44 +03:00