Commit graph

1167 commits

Author SHA1 Message Date
Jesse Rosenberger
011f0063aa
docs: Update links to new schema concepts. 2018-04-30 17:25:30 -07:00
Jesse Rosenberger
d688e555d7
Merge pull request #1012 from apollographql/abernix/meeting-1
docs: Iteration from Docs workshop.
2018-05-01 01:54:00 +03: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
a989314453
Merge pull request #1011 from apollographql/abernix/docs/editoral-1
docs: Editorial Pass
2018-04-30 22:08:55 +03:00
Jesse Rosenberger
b594ee6a33
Merge pull request #997 from apollographql/abernix/docs/api
[Work in Progress] docs: API > `apollo-server`.
2018-04-30 22:08:24 +03:00
Jesse Rosenberger
e273c35ba7
Merge branch 'docs-overhaul' into docs-essentials-data 2018-04-30 22:05:13 +03:00
Jesse Rosenberger
196ae929ac Tweaks to complexity limits. 2018-04-29 21:11:30 +03:00
Jesse Rosenberger
23529ac9bc Editorial: Best Practices > Security > DoS. 2018-04-29 21:02:20 +03:00
Jesse Rosenberger
3529c12a10 Tweaks to introspection. 2018-04-29 20:54:32 +03:00
Jesse Rosenberger
4b3bbafaf8 Editorial on "Best practices > Schema > Node Interface". 2018-04-29 19:44:02 +03:00
Jesse Rosenberger
fa0d70af73 Editorial on "Best Practices > Schema Design > Interfaces". 2018-04-29 18:51:42 +03:00
Jesse Rosenberger
0fa335ddc8 Change "Naming" to "Style conventions".
Keeping in mind that capitalization differences are not "naming"
conventions, and that there were no other recommendations for naming (e.g.
"begin each fetcher with "Get", etc.), I've changed this section to
"Style conventions".
2018-04-29 18:35:15 +03:00
Jesse Rosenberger
150423f53f
Rework Security Introspection. 2018-04-27 21:59:36 +03:00
Jesse Rosenberger
a212f5cb61
Rename page fragment to just 'introspection'. 2018-04-27 21:47:10 +03:00
Jesse Rosenberger
a4ae542e61
Re-work introduction to Security Best Practices.
While GraphQL is less susceptible to injection attacks, this introduction
made it sound like it wasn't possible, but the first paragraph then
demonstrated an injection attack and how to prevent it.
2018-04-27 21:42:04 +03:00
Jesse Rosenberger
d5fe357536
Re-work introduction on Best Practices > Performance. 2018-04-27 21:40:04 +03:00
Jesse Rosenberger
5091121228
Quick first pass, mostly spelling. 2018-04-27 19:16:00 +03:00
Jesse Rosenberger
e85fc6c347
Nits and editorial on earlier content in Schema 2018-04-27 18:18:11 +03:00
Jesse Rosenberger
1ae3ce2dc7
Remove grave accents, which do not work for titles. 2018-04-27 17:02:33 +03:00
Jesse Rosenberger
dfa4f61940
Merge branch 'docs-overhaul' into abernix/docs/api 2018-04-27 17:02:11 +03:00
Jesse Rosenberger
02f5c467ac
Change apollo-engine title to be without grave accents. 2018-04-27 17:01:57 +03:00
Jesse Rosenberger
d2ec5bb6d5
Clarify that gql must be imported, per feedback from @peggyrayzis. 2018-04-27 16:55:04 +03:00
Jesse Rosenberger
198b109e20
Drop ApolloServer.prototype. per feedback from @peggyrayzis. 2018-04-27 16:51:57 +03:00
Jesse Rosenberger
9625c0a7e2
Merge branch 'docs-overhaul' into abernix/docs/api 2018-04-27 16:41:43 +03:00
Jesse Rosenberger
0482216a64
docs: API: Change "Apollo Engine" title to be apollo-engine. 2018-04-27 16:41:11 +03:00
Jesse Rosenberger
7ce3099158
Bump the hexo version, which keeps getting lowered, back to 3.7.1. 2018-04-26 23:04:38 +03:00
Jesse Rosenberger
790ebbea7b
docs: API > apollo-server. 2018-04-26 22:37:14 +03:00
Evans Hauser
5f835cbbf1
docs: add short section to what's new about errors 2018-04-26 12:27:07 -07:00
Jesse Rosenberger
c09b352c95
docs: Add v2 to the versions property in _config.yml.
This should enable the dropdown box in the sidebar of the documentation.
Currently, that sidebar will be a terrible color, since it has never
appeared on Apollo documentation before and nobody has ever defined style on
it.  That'll have to be fixed in the theme itself[0].

[0]: https://github.com/meteor/meteor-theme-hexo
2018-04-26 14:35:53 +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
Evans Hauser
cd88fbe695
add creating schema directives to advanced section 2018-04-24 15:16:11 -07:00
Jake
57b56427dc [WIP] refined data fetching essentials 2018-04-24 12:55:02 -04:00
Jesse Rosenberger
4ff36d8575
docs: Sidebar: "Schema Development" > "Schema". (To fit on a single line.) 2018-04-24 18:00:19 +03: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
Jesse Rosenberger
f57cd6b34a docs: Variables as arguments. 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
1b9d32ddb0 s/name/identifier/ for named operations. 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
84c41ce21a docs: Respond to @evans feedback about programmatic introspection. 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
096e86821d docs: Clarify arguments. 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
9635b794fb docs: Draw attention to two of REST's downfalls: over-fetching and stiching. 2018-04-24 17:58:44 +03:00
Jesse Rosenberger
569c826470 TODO: Passing arguments as variables. 2018-04-24 17:58:44 +03:00