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

Update documentation to use STORAGES instead of STATICFILES_STORAGE setting for newer Django versions #831

Open
rockstarr-programmerr opened this issue Jan 14, 2025 · 0 comments

Comments

@rockstarr-programmerr
Copy link

rockstarr-programmerr commented Jan 14, 2025

The STATICFILES_STORAGE settings is deprecated in Django 4.2 and officially removed in Django 5.1

Not updating the documentation can lead to confusion for users of Django 5.1, as it will appear that django-pipeline simply doesn't do anything when the user follow the instruction and set STATICFILES_STORAGE instead of STORAGES.

I suggest updating the documentation to showcase using STATICFILES_STORAGE for Django < 4.2 and STORAGES for Django >= 4.2, for example:

For Django < 4.2:

STATICFILES_STORAGE = 'pipeline.storage.PipelineManifestStorage'

For Django >= 4.2:

STORAGES = {
    'default': {
        'BACKEND': <your default storage backend>,  # Django's default is 'django.core.files.storage.FileSystemStorage'
    },
    'staticfiles': {
        'BACKEND': 'pipeline.storage.PipelineManifestStorage',
    },
}
@rockstarr-programmerr rockstarr-programmerr changed the title Update documentation to use STORAGES instead of STATICFILES_STORAGE setting Update documentation to use STORAGES instead of STATICFILES_STORAGE setting for newer Django versions Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant