Skip to content

Commit

Permalink
Added introductions chapter
Browse files Browse the repository at this point in the history
  • Loading branch information
shabda committed Feb 6, 2018
1 parent 0189add commit f2a5198
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,17 @@ The chapters are based on a common set of models, which you can read in detail h
* Events: :code:`Epic`, :code:`Event`, :code:`EventHero`, :code:`EventVillian`
* Entities: :code:`Category`, :code:`Origin`, :code:`Hero`, :code:`Villain`

.. toctree::
:maxdepth: 1

introduction

Text and Design
+++++++++++++++++++++

.. toctree::
:maxdepth: 1
:numbered:

change_text
plural_text
Expand All @@ -31,6 +36,7 @@ Calculated fields

.. toctree::
:maxdepth: 1
:numbered:

calculated_fields
optimize_queries
Expand All @@ -43,6 +49,7 @@ Permissions

.. toctree::
:maxdepth: 1
:numbered:

specific_users
restrict
Expand All @@ -55,6 +62,7 @@ Multiple models and inlines

.. toctree::
:maxdepth: 1
:numbered:

edit_multiple_models
one_to_one_inline
Expand All @@ -66,6 +74,7 @@ Bulk and custom actions

.. toctree::
:maxdepth: 1
:numbered:

export
import
Expand All @@ -78,6 +87,7 @@ Listview Page

.. toctree::
:maxdepth: 1
:numbered:

increase_row_count
disable_pagination
Expand All @@ -89,6 +99,7 @@ Changeview Page

.. toctree::
:maxdepth: 1
:numbered:

imagefield
current_user
Expand All @@ -106,6 +117,7 @@ Misc

.. toctree::
:maxdepth: 1
:numbered:

object_url
add_model_twice
Expand Down
19 changes: 19 additions & 0 deletions docs/introduction.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Introduction
==============

Django Admin Cookbook is a book about doing things with Django admin. It is targetted towards intermediate Django developers,
who have some experience with Django admin, but are looking to expand their knowldge of Django admin and acieve mastery of Django admin.

It takes the form of about question and answers about common tasks you might do with Django admin. All the chapters are based on a common set of models, which you can read in detail here (:doc:`models`). In short, we have two apps,
:code:`events` and :code:`entities`. The models are

* Events: :code:`Epic`, :code:`Event`, :code:`EventHero`, :code:`EventVillian`
* Entities: :code:`Category`, :code:`Origin`, :code:`Hero`, :code:`Villain`


How to use this book
+++++++++++++++++++++++

You can read this book either from start to end, or search for the things you need to do and only read those chapters. Each chapter focusses on a single, specific task.

In either case, you should read the :code:`entities/models.py` and :code:`events/models.py` first.

0 comments on commit f2a5198

Please sign in to comment.