Opened 3 weeks ago
Closed 3 weeks ago
#37231 closed Cleanup/optimization (wontfix)
Expand the “How to delete a Django application” guide
| Reported by: | Angiep212 | Owned by: | Angiep212 |
|---|---|---|---|
| Component: | Uncategorized | Version: | 6.0 |
| Severity: | Normal | Keywords: | |
| Cc: | Angiep212 | Triage Stage: | Unreviewed |
| Has patch: | no | Needs documentation: | yes |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
The first step of the "How to delete a Django application" guide instructs users to "Remove all references to the app (imports, foreign keys, etc.)." While this is easily understood by experienced developers, it may not be clear to newer Django users what other references should be checked.
It may be helpful to include a few additional examples to make the documentation more descriptive and reduce the chance of leaving behind references to the removed application.
Some additional examples could include:
- Project settings
- URL references
- Views
- Forms
Change History (4)
comment:1 by , 3 weeks ago
| Needs documentation: | set |
|---|---|
| Type: | Uncategorized → Cleanup/optimization |
comment:2 by , 3 weeks ago
| Type: | Cleanup/optimization → New feature |
|---|
comment:3 by , 3 weeks ago
| Type: | New feature → Cleanup/optimization |
|---|
comment:4 by , 3 weeks ago
| Resolution: | → wontfix |
|---|---|
| Status: | assigned → closed |
Thank you for the ticket!
In order to confirm this is needed, do you have examples of users getting confused here? (forum/stackoverflow questions?). I would have thought the error would be quite clear if you forget something. Do you have an example where this is not clear?
Just want to confirm we have identified a true need for extra documentation before we add something in here as sometimes "less is more".