#35380: Have the images from docs/ref/contrib/admin/_images/ automatically
generated.
--------------------------------------+------------------------------------
Reporter: Sarah Boyce | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------
Comment (by Sarah Boyce):
> (despite already having the screenshot generation by code)
Unless I am missing something, these screenshots are not generated
automatically and in order to update the image, I had to:
- look at the image (and the docs around it) and figure out what I would
need to do to recreate this image
- make a project [https://docs.djangoproject.com/en/5.0/intro/contributing
/#creating-projects-with-a-local-copy-of-django using steps documented
here]
- do steps to recreate the image - code/migrate/shell etc
- take a screenshot
I'm not sure if that answers the question. There are other approached to
make this easier like having a project already setup with test data with
some instructions.
> asking for a PR that touches the admin to re-generate these screenshots
I think we can ask that people do this. I would expect we update the
contributor docs with how to update the images whether that's a script or
a project they can use or something something.
> If we would automatically generate these images, when/where would this
regeneration go? As part of a release when building and checking release
notes? As part of the same PR that changes something in the admin? As a
follow up PR?
Ideally part of the same PR that change something in the admin but we
should also check it as part of a release when building and checking
release notes 👍
--
Ticket URL: <https://code.djangoproject.com/ticket/35380#comment:2>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/0107018eec71f0b2-c87dcdcd-ab86-447f-ae2c-cde575e40ade-000000%40eu-central-1.amazonses.com.
