Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation about permissions handling using the API. #146

Merged
merged 3 commits into from
Aug 14, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
8 changes: 4 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
==================
Expand Down Expand Up @@ -54,7 +54,7 @@ Table of content
:maxdepth: 1

installation
tutorial
tutorials/index
configuration
deployment
permissions
Expand Down
2 changes: 2 additions & 0 deletions docs/permissions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
==================

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial.rst → docs/tutorials/first-steps.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _tutorial:
.. _tutorial-first-steps:

First steps with Kinto
######################
Expand Down
10 changes: 10 additions & 0 deletions docs/tutorials/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _tutorials:

Tutorials
#########

.. toctree::
:maxdepth: 2

first-steps
permissions
Loading