From 25022f58d8d7a72d5ee2d93eea681ee6217a021d Mon Sep 17 00:00:00 2001
From: Kevin Abiera <kevin@abiera.com>
Date: Mon, 4 Jan 2016 01:51:25 +0800
Subject: [PATCH] Add Django graphql_schema command documentation

---
 docs/pages/docs/introspection-schema.md | 50 +++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 docs/pages/docs/introspection-schema.md

diff --git a/docs/pages/docs/introspection-schema.md b/docs/pages/docs/introspection-schema.md
new file mode 100644
index 00000000..d8c8187e
--- /dev/null
+++ b/docs/pages/docs/introspection-schema.md
@@ -0,0 +1,50 @@
+---
+title: Introspection Schema
+description: A guide to instrospection schema in Django
+---
+
+# Introspection Schema
+
+Relay uses [Babel Relay Plugin](https://facebook.github.io/relay/docs/guides-babel-plugin.html)
+that requires you to provide your GraphQL schema data.
+
+Graphene comes with a management command for Django to dump your schema data to
+`schema.json` that is compatible with babel-relay-plugin.
+
+
+## Usage
+
+Include `graphene.django.contrib` to `INSTALLED_APPS` in you project settings:
+
+```python
+INSTALLED_APPS += ('graphene.django.contrib')
+```
+
+Assuming your Graphene schema is at `tutorial.quickstart.schema`, run the command:
+
+```bash
+./manage.py graphql_schema --schema tutorial.quickstart.schema --out schema.json
+```
+
+It dumps your full introspection schema to `schema.json` inside your project root
+directory. Point `babel-relay-plugin` to this file and you're ready to use Relay
+with Graphene GraphQL implementation.
+
+
+## Advanced Usage
+
+To simplify the command to `./manage.py graphql_schema`, you can specify the
+parameters in your settings.py:
+
+```python
+GRAPHENE_SCHEMA = 'tutorial.quickstart.schema'
+GRAPHENE_SCHEMA_OUTPUT = 'data/schema.json'  # defaults to schema.json
+```
+
+Running `./manage.py graphql_schema` dumps your schema to
+`<project root>/data/schema.json`.
+
+
+## Help
+
+Run `./manage.py graphql_schema -h` for command usage.