From 315df258ef953fcccb687049b987b65dde8a1f88 Mon Sep 17 00:00:00 2001 From: Patrick Arminio Date: Sat, 18 Nov 2017 07:44:53 +0000 Subject: [PATCH] Improve index --- docs/tutorial/index.rst | 17 ++++++++++++----- docs/tutorial/part-1.rst | 2 ++ 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/docs/tutorial/index.rst b/docs/tutorial/index.rst index b6f91c76..3cfca9f9 100644 --- a/docs/tutorial/index.rst +++ b/docs/tutorial/index.rst @@ -8,13 +8,20 @@ We will assume that you already have Graphene installed. The tutorial will be based on Graphene 2.0 and Python 3.6. TODO: link to installation documentation. -TODO: explain what we are going to do. + +In this tutorial we are going to build a super simple polls application, +the user will be able to query all the questions and the will be able to +answer each question by id. + +We won't be using a database for now, since we'd like to keep this +tutorial simple and not force you to use a specific framework. Creating your project --------------------- -TODO: explain what the usual structure for a Graphene schema looks -like. +Each graphene project is composed of a single Schema ( + TODO: link to what a schema is in the GraphQL documentation +), the suggested convention is to create a main ``schema.py`` file which +will contain your schema and ``schema.py`` files for each of your module. -TODO: link to first step of the tutorial, which will be the creation of -the first schema. +Let's starts by creating your first GraphQL schema, go to :ref:`tutorial-part-1`. diff --git a/docs/tutorial/part-1.rst b/docs/tutorial/part-1.rst index 1c70127a..f75444e2 100644 --- a/docs/tutorial/part-1.rst +++ b/docs/tutorial/part-1.rst @@ -1,3 +1,5 @@ +.. _tutorial-part-1: + Create your first schema ========================