Opened 3 months ago

Last modified 3 weeks ago

#35380 new Cleanup/optimization

Have the images for tutorial and admin docs programatically generated.

Reported by: Sarah Boyce Owned by: nobody
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: no UI/UX: no

Description (last modified by Natalia Bidart)

Noticed in the process of reviewing this PR that there was an image in the documentation that required an update.
I think most of the images are "slightly" out of date due to in part to the accessibility push which has done some CSS contrast updates.

We already have the ability to generate screenshots during our Selenium tests, so it might be a nice idea to have our documentation screenshots generated in a similar way.

All the screenshots in the docs would need generation upon the trigger of a command (i.e. manually via a Makefile or similar).

Change History (11)

comment:1 by Natalia Bidart, 3 months ago

Component: UncategorizedDocumentation
Triage Stage: UnreviewedAccepted

Accepting because I agree that outdated images in docs are confusing. I have some questions though:

Do you think that the effort to put the machinery in place (despite already having the screenshot generation by code) is worth the effort vs asking for a PR that touches the admin to re-generate these screenshots? (I'm honestly not sure!)

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?

comment:2 by Sarah Boyce, 3 months ago

(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 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 👍

comment:3 by Natalia Bidart, 3 months ago

Thank you Sarah, I agree with your rationale! we could perhaps consider a custom Sphinx extension to build the images if certain conditions are met?

comment:4 by Tim Graham, 3 months ago

I think it would be enough to double check if the the screenshots need updating once for each major release (probably at alpha stage). Certainly if there are obvious UI changes that affect the screenshots they could be updated as part of each change, but I wouldn't require it for each CSS tweak. It's unlikely beginners are going to be using the development version of Django for the tutorial anyway. I don't think this problem merits spending a lot of time on building automation. Outdated screenshots hasn't been a big issue over the years.

comment:5 by Natalia Bidart, 8 weeks ago

Has patch: set
Patch needs improvement: set

Setting has_patch to start the conversation on the topic, but the PR definitely needs improvement.

comment:6 by GitHub <noreply@…>, 4 weeks ago

In bcc327aa:

Refs #35380 -- Updated screenshots in admin docs.

When listing users, ensure that user first and last name are diverse.

comment:7 by Natalia <124304+nessita@…>, 4 weeks ago

In 3fb3b8a:

[5.1.x] Refs #35380 -- Updated screenshots in admin docs.

When listing users, ensure that user first and last name are diverse.

Backport of bcc327aa326093a39f01a9bc98198807444900f3 from main.

comment:8 by nessita <124304+nessita@…>, 4 weeks ago

In a6dde9f:

Refs #35380 -- Updated screenshots in intro docs.

comment:9 by Natalia <124304+nessita@…>, 4 weeks ago

In 6a574d7:

[5.1.x] Refs #35380 -- Updated screenshots in intro docs.

Backport of a6dde9fbd545d85f0bc2654f2ebfc6f74f3c4791 from main.

comment:10 by Natalia Bidart, 4 weeks ago

Description: modified (diff)
Summary: Have the images from docs/ref/contrib/admin/_images/ automatically generated.Have the images for tutorial and admin docs programatically generated.

comment:11 by Natalia Bidart, 3 weeks ago

Description: modified (diff)
Note: See TracTickets for help on using tickets.
Back to Top