Opened 3 years ago

Closed 2 years ago

#17935 closed Cleanup/optimization (fixed)

Media and Static files docs

Reported by: guettli Owned by: Fandekasp
Component: Documentation Version: 1.4
Severity: Normal Keywords:
Cc: hv@…, lemaire.adrien@… Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: yes UI/UX: no

Description

Old:

This document describes Django’s file access APIs.

New:

This document describes Django’s file access APIs for FileField and ImageField. If you want to handle static files (JS, CSS, ...) see Managing static files.

Attachments (2)

doc-media-files.patch (666 bytes) - added by guettli 3 years ago.
0001-cleaning-media-and-static-files-docs-urls.patch (67.1 KB) - added by Fandekasp 3 years ago.

Download all attachments as: .zip

Change History (9)

Changed 3 years ago by guettli

comment:1 Changed 3 years ago by claudep

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement set
  • Triage Stage changed from Unreviewed to Accepted

The link to static files is welcome. However, the page is more than mere FileField and ImageField. Could you try to find a formulation that better represents the page content?

comment:2 Changed 3 years ago by Fandekasp

  • Owner changed from nobody to Fandekasp

I'm going to offer a bigger patch.
For me, this is just "Managing Media files", and therefore it doesn't make sense to have a /topics/files for media files and /howto/static-files/ for static files.

comment:3 Changed 3 years ago by Fandekasp

  • Version changed from 1.3 to 1.4

comment:4 Changed 3 years ago by Fandekasp

  • Cc lemaire.adrien@… added

comment:5 Changed 3 years ago by Fandekasp

  • Summary changed from Media Files docs: Link to static files doc to Media and Static files docs
  • Triage Stage changed from Accepted to Design decision needed

Changing the stage to DDN as I realized I went over the initial purpose of this ticket.

Here what I did:

  • Clearly name "Managing media files" or "Managing static files" when calling those docs
  • Move /topics/files into /topics/files/media
  • Move /howto/static-files into /topics/files/static

comment:6 Changed 2 years ago by timo

  • Triage Stage changed from Design decision needed to Accepted

I don't think we'll move the files around (the patch won't apply cleanly after #19897), but moving back to accepted to finish the initial scope of the ticket.

comment:7 Changed 2 years ago by Tim Graham <timograham@…>

  • Resolution set to fixed
  • Status changed from new to closed

In f7795e968dd07323aa5bd16f9da0e60d97a75d0f:

Fixed #17935 - Clarified intro of topics/files.txt.

Thanks guettli for the suggestion.

Note: See TracTickets for help on using tickets.
Back to Top