Re: [Django] #35380: Have the images for tutorial and admin docs programatically generated.

[Django]

#35380: Have the images for tutorial and admin docs programatically generated.
--------------------------------------+------------------------------------
Reporter: Sarah Boyce | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------
Description changed by Natalia Bidart:

Old description:

> Noticed in the process of reviewing
> [https://github.com/django/django/pull/17910/ 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
> [https://docs.djangoproject.com/en/dev/internals/contributing/writing-
> code/unit-tests/#running-the-selenium-tests 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, Django management command, or
> similar).

New description:

Noticed in the process of reviewing
[https://github.com/django/django/pull/17910/ 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
[https://docs.djangoproject.com/en/dev/internals/contributing/writing-code
/unit-tests/#running-the-selenium-tests 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).

--
--
Ticket URL: <https://code.djangoproject.com/ticket/35380#comment:11>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#35380: Have the images for tutorial and admin docs programatically generated.
--------------------------------------+------------------------------------
Reporter: Sarah Boyce | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------

Comment (by nessita <124304+nessita@…>):

In [changeset:"fb6050e7845fe1a5fa131708be65ad89a31a2633" fb6050e7]:
{{{#!CommitTicketReference repository=""
revision="fb6050e7845fe1a5fa131708be65ad89a31a2633"
Refs #35380 -- Updated screenshots in intro docs.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/35380#comment:12>

[Django]

#35380: Have the images for tutorial and admin docs programatically generated.
--------------------------------------+------------------------------------
Reporter: Sarah Boyce | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------
Comment (by nessita <124304+nessita@…>):

In [changeset:"90adba85b29230acfe354bffd82bc0d3a4d63c9d" 90adba8]:
{{{#!CommitTicketReference repository=""
revision="90adba85b29230acfe354bffd82bc0d3a4d63c9d"
Refs #35380 -- Updated screenshots in admin docs.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/35380#comment:13>

[Django]

#35380: Have the images for tutorial and admin docs programatically generated.
--------------------------------------+------------------------------------
Reporter: Sarah Boyce | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------

Comment (by Natalia <124304+nessita@…>):

In [changeset:"06fb6434b3b5750c678292bbf52944508c40566c" 06fb643]:
{{{#!CommitTicketReference repository=""
revision="06fb6434b3b5750c678292bbf52944508c40566c"
[5.1.x] Refs #35380 -- Updated screenshots in admin docs.

Backport of 90adba85b29230acfe354bffd82bc0d3a4d63c9d from main.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/35380#comment:15>

[Django]

#35380: Have the images for tutorial and admin docs programatically generated.
--------------------------------------+------------------------------------
Reporter: Sarah Boyce | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------
Comment (by Natalia <124304+nessita@…>):

In [changeset:"e934dcfb854d2984453aef51a0a90af45ceb1e92" e934dcfb]:
{{{#!CommitTicketReference repository=""
revision="e934dcfb854d2984453aef51a0a90af45ceb1e92"
[5.1.x] Refs #35380 -- Updated screenshots in intro docs.

Backport of fb6050e7845fe1a5fa131708be65ad89a31a2633 from main.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/35380#comment:14>

[Django]

#35380: Have the images for tutorial and admin docs programatically generated.
--------------------------------------+------------------------------------
Reporter: Sarah Boyce | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------

Changes (by Natalia Bidart):

* cc: Simon Willison (added)

Comment:

After `DjangoCon US 2024`, Simon shared a PoC to automatically take
screenshots of admin pages for a Django project: https://github.com/simonw
/django-screenshots/

We should evaluate the project to automatically generate screenshots for
the Django docs, though it would add a gew new dependencies (`playwright`
and `shot-scraper` after a quick inspection).
--
Ticket URL: <https://code.djangoproject.com/ticket/35380#comment:16>

[Django]

#35380: Have the images for tutorial and admin docs programatically generated.

-------------------------------------+-------------------------------------
Reporter: Sarah Boyce | Owner:
Type: | marcorichetta
Cleanup/optimization | Status: assigned

Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by marcorichetta):

* owner: nobody => marcorichetta
* status: new => assigned

Comment:

As already talked with Natalia, I'll be taking her PR to move forward with
this ticket.
--
Ticket URL: <https://code.djangoproject.com/ticket/35380#comment:17>

[Django]

#35380: Have the images for tutorial and admin docs programatically generated.
-------------------------------------+-------------------------------------

Reporter: Sarah Boyce | Owner: Marco
Type: | Richetta

Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Adya):

Replying to [comment:17 Marco Richetta]:

> As already talked with Natalia, I'll be taking her PR to move forward
with this ticket.

Hi Marco, Are you working on this ticket or can I work on it?
--
Ticket URL: <https://code.djangoproject.com/ticket/35380#comment:18>

[Django]

#35380: Have the images for tutorial and admin docs programatically generated.

--------------------------------------+------------------------------------
Reporter: Sarah Boyce | Owner: Adya
Type: Cleanup/optimization | Status: assigned

Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0

--------------------------------------+------------------------------------
Changes (by Adya):

* owner: Marco Richetta => Adya

--
Ticket URL: <https://code.djangoproject.com/ticket/35380#comment:19>

[Django]

#35380: Have the images for tutorial and admin docs programatically generated.

-------------------------------------+-------------------------------------
Reporter: Sarah Boyce | Owner: Marco
Type: | Richetta

Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Natalia Bidart):

* cc: Marco, Richetta (added)
* owner: Adya => Marco Richetta

Comment:

Hey Adya, thanks for the eagerness to contribute to Django but this ticket
is assigned and Marco is working on it.
--
Ticket URL: <https://code.djangoproject.com/ticket/35380#comment:20>

[Django]

#35380: Have the images for tutorial and admin docs programatically generated.
-------------------------------------+-------------------------------------
Reporter: Sarah Boyce | Owner: Marco
Type: | Richetta
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Adya):

Replying to [comment:20 Natalia Bidart]:

> Hey Adya, thanks for the eagerness to contribute to Django but this
ticket is assigned and Marco is working on it.

Sorry Natalia

But I have already talked to Mark and Sarah. Sarah recommended this ticket
to me, and due to some time constraints, Marco handed me this ticket and
also gave some guidance.
Kindly check our chat thread: https://forum.djangoproject.com/t/gsoc-25
-proposal-draft-automate-processes-within-django-contribution-
workflow/39723/10
After that confirmation, I assigned it to myself and then started working.

**Can you kindly assign it to me so that I can continue**

If so, I also know your better understanding of this ticket. Would you
suggest me some guidance, how I should approach it?
--
Ticket URL: <https://code.djangoproject.com/ticket/35380#comment:21>

[Django]

#35380: Have the images for tutorial and admin docs programatically generated.
-------------------------------------+-------------------------------------
Reporter: Sarah Boyce | Owner: Marco
Type: | Richetta
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Sarah Boyce):

I see on the forum that Marco was indeed working on this ticket. In which
case, it's not an appropriate choice.
I only suggested it as it is an example of an area we want to automate,
you can learn from the ticket without assigning yourself.
In general, I would not recommend assigning yourself to a ticket if you
don't have an idea on how to approach it.
--
Ticket URL: <https://code.djangoproject.com/ticket/35380#comment:22>

[Django]

#35380: Have the images for tutorial and admin docs programatically generated.
-------------------------------------+-------------------------------------
Reporter: Sarah Boyce | Owner: Marco
Type: | Richetta
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Adya):

Replying to [comment:22 Sarah Boyce]:

> I see on the forum that Marco was indeed working on this ticket. In
which case, it's not an appropriate choice.
> I only suggested it as it is an example of an area we want to automate,
you can learn from the ticket without assigning yourself.
> In general, I would not recommend assigning yourself to a ticket if you
don't have an idea on how to approach it.

Ya! It makes sense.

I will follow the same. Since I have initiated I will work on it on
locally only for understanding (it's crucial) but will not make any PR are
such.
That's why I was waiting for confirmation and did not assign to myself
again
--
Ticket URL: <https://code.djangoproject.com/ticket/35380#comment:23>