From ef66614a80086c5853552428490d4e8e9b12ba58 Mon Sep 17 00:00:00 2001 From: Daniel Quinn Date: Wed, 28 Mar 2018 15:23:17 +0100 Subject: [PATCH] Add grammar fixes. --- docs/dashboard_custom.rst | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/dashboard_custom.rst b/docs/dashboard_custom.rst index 4f63fbf3..669f3cc3 100644 --- a/docs/dashboard_custom.rst +++ b/docs/dashboard_custom.rst @@ -4,15 +4,15 @@ Custom Dashboard .. note:: Django JET Dashboard tries to be as compatible as possible with django-admin-tools dashboard so that - django-admin-tools modules could be easily ported to Django JET. In most cases in will be enough to + django-admin-tools modules could be easily ported to Django JET. In most cases it will be enough to change python imports and remove extending in modules templates. -Dashboard represents ``Dashboard`` class instance with ``DashboardModule`` class instances as its children. -Any custom **Dashboard** class should inherit ``jet.dashboard.dashboard.Dashboard`` +Dashboard represents ``Dashboard`` class instances with ``DashboardModule`` class instances as its children. +Any custom **Dashboard** class should inherit from ``jet.dashboard.dashboard.Dashboard`` and use ``init_with_context`` to fill it with widgets. You should add your widgets -to ``children`` and ``available_children`` attributes. +to the ``children`` and ``available_children`` attributes. -Before continue make sure you have completed :doc:`install_dashboard`. +Before you continue, make sure you have completed the :doc:`install_dashboard`. Set Up Custom Dashboard ----------------------- @@ -55,12 +55,14 @@ Set Up Custom Dashboard )) -* Add to your settings.py path to created ``dashboard.py`` (example for ``dashboard.py`` in project root): +* Add the path to your ``dashboard.py`` in your ``settings.py`` file. For example, if your + ``dashboard.py`` is in the project root: .. code:: python JET_INDEX_DASHBOARD = 'dashboard.CustomIndexDashboard' -That's all, now you have dashboard with only one widget - ``LinkList``. Dashboard reset may be needed -if your had another dashboard already rendered for any user. Visit :doc:`dashboard_modules` to learn -other widgets you can add to your custom dashboard or :doc:`dashboard_custom_module` to create your own. \ No newline at end of file +That's all, now you have a dashboard with only one widget - ``LinkList``. Dashboard reset may be needed +if you had another dashboard already rendered for any user. Visit :doc:`dashboard_modules` to learn +about other widgets you can add to your custom dashboard or :doc:`dashboard_custom_module` or to create +your own.