respondcreate / django-versatileimagefield

A drop-in replacement for django's ImageField that provides a flexible, intuitive and easily-extensible interface for quickly creating new images from the one assigned to the field.
http://django-versatileimagefield.readthedocs.io/
MIT License
530 stars 90 forks source link

Unclear docs on using VersatileImageFieldWarmer with rendition sets #172

Closed smileservices closed 3 years ago

smileservices commented 3 years ago

The docs at https://django-versatileimagefield.readthedocs.io/en/latest/improving_performance.html are not complete. It's unclear how the rendition sets should look like. The code docs on VersatileImageFieldWarmer are not clear either. Could not make it work by following the instructions on the docs.

Need an example of usage with rendition sets, minimal model and template usage.

respondcreate commented 3 years ago

Hey @smileservices !

You can get an overview of how rendition key sets work by taking a look at the DRF integration page of the docs or the settings docs here.