Merge pull request #146 from Kinto/document-permission-api

Add tutorial for permissions
Kinto · Aug 14, 2015 · 2e0de11 · 2e0de11
2 parents 1907236 + 1869736
commit 2e0de11
Show file tree

Hide file tree

Showing 6 changed files with 538 additions and 6 deletions.
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -11,6 +11,5 @@ The HTTP APIs
    records
    groups
 
-
 See `cliquet API documentation <http://cliquet.readthedocs.org/en/latest/api/index.html>`_
 for an exhaustive list of features and endpoints of the *Kinto* API.
diff --git a/docs/index.rst b/docs/index.rst
@@ -18,11 +18,11 @@ The server doesn't impose anything about the records data model.
 
 *Kinto* is based on top of `cliquet <http://cliquet.readthedocs.org>`_.
 
-Tutorial
-========
+Tutorials
+=========
 
 Sometimes it is easier to get started by following a
-tutorial. :ref:`Learn how to store, manage and sync your data <tutorial>`.
+tutorial. :ref:`Learn how to store, sync and share your data <tutorials>`.
 
 Using the HTTP API
 ==================
@@ -54,7 +54,7 @@ Table of content
    :maxdepth: 1
 
    installation
-   tutorial
+   tutorials/index
    configuration
    deployment
    permissions

diff --git a/docs/permissions.rst b/docs/permissions.rst
@@ -186,6 +186,8 @@ There are two special principals:
   principal is useful when a rule should apply to all users.
 
 
+.. _permissions_usecases:
+
 Use-cases examples
 ==================
 

diff --git a/docs/tutorial.rst → docs/tutorials/first-steps.rst b/docs/tutorial.rst → docs/tutorials/first-steps.rst
@@ -1,4 +1,4 @@
-.. _tutorial:
+.. _tutorial-first-steps:
 
 First steps with Kinto
 ######################

diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst
@@ -0,0 +1,10 @@
+.. _tutorials:
+
+Tutorials
+#########
+
+.. toctree::
+   :maxdepth: 2
+
+   first-steps
+   permissions