Commit graph

46 commits

Author SHA1 Message Date
unicodeveloper
9ab06f46c4 Fix links 2018-05-03 09:45:05 -07:00
unicodeveloper
173ac54cd0 Add links for graphql-subscriptions and apollo-engine 2018-05-03 09:38:09 -07:00
unicodeveloper
c141239b79 Add migration 2 guide 2018-05-03 09:36:23 -07:00
Jesse Rosenberger
9ab4f9d0f8
Merge pull request #942 from apollographql/docs-overhaul
[Work in Progress] 2.0 Documentation
2018-05-02 17:41:48 -07:00
Jesse Rosenberger
5c6dc4f93f
hide sidebar links, for now 2018-05-02 17:12:55 -07:00
PROSPER OTEMUYIWA
08879ff0a6 Add migration for 2.0 beta 2018-05-02 15:59:51 -07:00
Evans Hauser
32caf0aa10
docs: add error handling section 2018-05-02 11:19:14 -07:00
Jesse Rosenberger
b9d49ae723
Enable version support via Netlify redirects.
This uses `hexo-versioned-netlify-redirects`[0], a package I wrote just for
this purpose (on Meteor) a few months back.

With any luck, this will do the trick for Apollo too.

[0]: https://github.com/meteor/hexo-versioned-netlify-redirects
2018-05-01 21:37:16 -07:00
Jesse Rosenberger
b2691adaa4
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-05-01 21:37:16 -07:00
Sashko Stubailo
727d782f66 Organize into features section 2018-05-01 14:48:54 -07:00
Evans Hauser
72a59260d5 Schema Organization and Manage a Large Schema (#996)
* docs: simplify schema organization and add modularize schema advanced section

* docs: working around code snippets demonstating how to organize a large schema

* update headers to be h tags and capitalization

* docs: intro to each file in modularize schema and circular reference full type defs

* docs: schema modularization formatting

* docs: shorten wording around intros to code snippets

* Move modularization to organizaition

* docs: removed circular dependencies section from schema organization
2018-05-01 14:09:52 -07:00
Evans Hauser
de7f20990b Forklift Schema Stitching Docs from graphql-tools (#1008)
* docs: copy initial stitching sections from graphql-tools

* docs: convert schema stitching introduction to use apollo-server

* docs: remote-schema shortened to contain links only

* docs: schema delegation shortened to remove api reference

* docs: rename schema-stitching to features
2018-05-01 14:07:14 -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
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
Jesse Rosenberger
4ff36d8575
docs: Sidebar: "Schema Development" > "Schema". (To fit on a single line.) 2018-04-24 18:00:19 +03:00
Jesse Rosenberger
36a07bb3bb
docs: API reference: Link to graphql-tools. 2018-04-24 14:17:04 +03:00
James Baxley
bdc2a82db8 docs: Best practices (#978)
* clean up some code examples

* add in some best practies
2018-04-23 22:01:54 +03:00
Jesse Rosenberger
e4977737e9
Rename slugs for "Essentials" pages to match other naming conventions.
Plus, slugs.

cc @JakeDawkins
2018-04-23 19:04:03 +03:00
Jesse Rosenberger
ac6411b238
Further-remove "Query Mechanics", this time from the sidebar.
It was already deleted elsewhere.
2018-04-23 12:47:18 +03:00
Evans Hauser
99a39907f4
add advanced section for scalars and enums 2018-04-22 23:40:56 -07:00
Jesse Rosenberger
3acdacbfa9
Context 👋 2018-04-20 20:36:32 +03:00
Jesse Rosenberger
081e69faf8
"Why Apollo?" 👉 "Why Apollo Server?" 2018-04-20 19:25:24 +03:00
Jesse Rosenberger
570fa609ba
Remove permissions residue. 2018-04-20 17:52:17 +03:00
Jesse Rosenberger
770c12cc30
Remove secrets. 2018-04-20 17:52:01 +03:00
Jesse Rosenberger
310368e705
Fix deployment sections. 2018-04-20 17:49:52 +03:00
Jesse Rosenberger
c475f95fd2
Infrastructure 👋 2018-04-20 17:46:39 +03:00
Jesse Rosenberger
ac8d19a594
Backends 👋 2018-04-20 17:44:40 +03:00
Jesse Rosenberger
d68695ed91
Remove Engine. 2018-04-20 17:32:08 +03:00
Jesse Rosenberger
cc6c8921cc
Remove subscriptions. 2018-04-20 17:30:48 +03:00
Jesse Rosenberger
3c79bf17e8
Remove schema stitching. 2018-04-20 17:30:23 +03:00
Jesse Rosenberger
d0b24a2381
Follow-up on previous commit. 2018-04-20 17:29:11 +03:00
Evans Hauser
43a7a99f2e
add deploy section for heroku 2018-04-19 21:41:27 -07:00
Jesse Rosenberger
8d5a37f1f0
👾 Update docs with content from Glitch. 2018-04-19 14:19:36 +03:00
James Baxley
2d9b47bc2d updates from feedback with @abernix 2018-04-05 09:53:52 -04:00
James Baxley
53efef676e added some more outlines 2018-04-05 02:31:10 -04:00
James Baxley
acbfba50ab initial starting point for new docs 2018-04-05 01:24:56 -04:00
Jesse Rosenberger
c9537d30e3 docs: Further standardize format of _config.yml files.
Many of these comments are unhelpful anyway and deserve to be maintained in the
"doc docs" (yes, docs for the docs), which live at https://github.com/apollographql/docs-docs/.
2018-03-23 20:08:31 +02:00
Jesse Rosenberger
7e58334839 docs: Remove api keys which are now set globally by apollo-hexo-config.
These are now defined by https://github.com/apollographql/apollo-hexo-config
and no longer necessary to be individually defined in each deployment.
2018-03-23 20:08:31 +02:00
Sashko Stubailo
4cf8200983
Improve related section (#901) 2018-03-21 13:31:46 -07:00
Jesse Rosenberger
fbdcac1a0f
[docs] Use package-based Hexo theme, rather than a Git submodule. (#869)
* docs: Use `devDependencies` instead of `dependencies`.

It's safe to mark all dependencies of this theme as 'dev' dependencies, as
none of them are needed to be installed in a production setting.

This was done automatically, so in some cases, this merges existing
`devDependencies`, and may also have added a missing `nodemon` `devDependency`
in cases where it was missing.  In other cases, this commit may not have
made such a change.

* docs: Remove _config.yml options now covered by global theme config.

* docs: Add `_multiconfig.yml`, a build artifact, to docs `.gitignore`.

* docs: Use theme from npm, rather than submodule, using `chexo`.

The theme which the docs in this repository are based on
([`hexo-theme-meteor`](https://github.com/meteor/hexo-theme-meteor)) has been
published to npm.

Additionally, most of the configuration which was once present in this
repository's `_config.yml` file, has been moved into an Apollo-centric theme
configuration npm,
[`apollo-hexo-config`](https://www.npmjs.com/package/apollo-hexo-config) (and
similarly, [GitHub](https://github.com/apollographql/apollo-hexo-config)).

The theme bundled in this npm is a converged version of the two `apollo`
and `master` branches on the `hexo-theme-meteor` repository, which is a result
of the work undertaken in https://github.com/meteor/hexo-theme-meteor/pull/51.

Lastly, this makes use of a new `chexo` npm which acts as a wrapper for `hexo`
but permits the use of an inherited configuration from npm, rather than a
statically defined CLI file parameter (previously with `--config a,b`).

* docs: Upgrade Hexo generator/tag/server dependencies.

* docs: Add missing `meteor-theme-hexo` package.

This was apparently missed, only on this repository (???) in my automated
commits, probably due to my own error.
2018-03-12 21:13:22 +02:00
Sashko Stubailo
62158acbd1
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
2017-12-11 23:44:32 -08:00
Sashko Stubailo
93f052352c
Docs improvements (#692)
* Freshen up title page

* Improve homepage further

* File a PR!

* Try adding express README to sidebar

* Add READMEs to docs

* Add example page, overhaul setup

* More stuff

* Fix all old URLs

* Eliminate all mentions of graphql-server

* Fix azure functions shit
2017-12-11 23:11:11 -08:00
Sashko Stubailo
53ad6351d7 Add Related section, update theme 2017-12-11 21:12:13 -08:00
Sashko Stubailo
4df47fa5e2
Update _config.yml 2017-12-07 23:00:17 -08:00
Martijn Walraven
d6bb52cae2 Update nav logo in docs 2017-10-24 12:35:01 -07:00
Martijn Walraven
213acbba32 Add additional docs files 2017-10-16 17:15:08 -07:00