Skip to content

Commit e3bfddd

Browse files
committed
more links to django settings
1 parent 7ac184d commit e3bfddd

File tree

4 files changed

+10
-4
lines changed

4 files changed

+10
-4
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,14 @@ Data Wizard is designed to allow users to iteratively refine their data import f
3131
* [Installation][installation]
3232
* [Initial Configuration][initial-configuration]
3333
* [**Target Model Registration (required)**][target-model-registration]
34+
* [Usage][workflow]
3435
* [wq Framework Integration (optional)][wq-setup]
3536
2. **API Documentation**
3637
* [Run API][api]
3738
* [Admin Screens][admin]
3839
* [Command-Line Interface][cli]
3940
3. **Advanced Customization**
41+
* [Django Settings][settings]
4042
* [Data Model][models]
4143
* [Custom Serializers][serializers]
4244
* [Custom Data Sources][sources]
@@ -67,6 +69,7 @@ Data Wizard is designed to allow users to iteratively refine their data import f
6769
[columns]: https://django-data-wizard.wq.io/api/columns
6870
[ids]: https://django-data-wizard.wq.io/api/ids
6971
[data]: https://django-data-wizard.wq.io/api/data
72+
[settings]: https://django-data-wizard.wq.io/config/settings
7073
[models]: https://django-data-wizard.wq.io/config/models
7174
[tasks]: https://django-data-wizard.wq.io/config/tasks
7275
[backends]: https://django-data-wizard.wq.io/config/backends

docs/config/settings.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,11 +79,10 @@ Note that `DATA_WIZARD['PERMISSION']` is intentionally configured separately fro
7979

8080
### `DATA_WIZARD['AUTO_IMPORT_TASKS']`
8181

82-
This lsit defines the sequence of tasks to execute when running the [auto] API. The default list is recommended for most projects.
82+
This list defines the sequence of tasks to execute when running the [auto] API. The default list is recommended for most projects.
8383

8484
Task | Description
85-
---|---
86-
85+
-----|-------------
8786
`data_wizard.tasks.check_serializer` | Ensure that a registered serializer (target model) is selected
8887
`data_wizard.tasks.check_iter` | Ensure that the file data can be loaded from the source model
8988
`data_wizard.tasks.check_columns` | Ensure that columns from the source file can be mapped to fields in the target model serializer

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ wq_config:
1212

1313
[**Django Data Wizard on GitHub**](https://github.com/wq/django-data-wizard)
1414

15-
[![Using Django Data Wizard](./images/screenshots/workflow.png)](./guides/using-django-data-wizard.md)
15+
[![Using Django Data Wizard](./images/screenshots/workflow.png)](https://django-data-wizard.wq.io/guides/using-django-data-wizard.md)
1616

1717
## News
1818

docs/overview/setup.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ INSTALLED_APPS = (
2727
'data_wizard',
2828
'data_wizard.sources',
2929
)
30+
```
3031

3132
> If you want to use a [custom data source][sources] instead of the built-in data source tables (`FileSource` and `URLSource`), do not include `data_wizard.sources` in your `INSTALLED_APPS`.
3233
@@ -44,6 +45,8 @@ urlpatterns = [
4445

4546
> If you are using Django Data Wizard's [wq framework integration][wq-setup], you do not need to update urls.py.
4647
48+
Finally, if you would like to override any of the default settings, add a [`DATA_WIZARD` configuration][settings] to your Django settings.
49+
4750
### Target Model Registration
4851

4952
In order to use the wizard, you **must** register one or more target models and/or serializers. Target model registration helps the wizard know where to put the data it finds in each row of the source spreadsheet. (By contrast, *source* model registration is optional, as long as you are using the provided `data_wizard.sources` app.)
@@ -66,6 +69,7 @@ Once everything is configured, upload a source file in the provided [Django admi
6669

6770
[sources]: ../sources.md
6871
[wq-setup]: ../guides/integrate-with-wq-framework.md
72+
[settings]: ../config/settings.md
6973
[serializers]: ../config/serializers.md
7074
[admin]: ../api/admin.md
7175
[workflow]: ../guides/using-django-data-wizard.md

0 commit comments

Comments
 (0)