Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Script to auto-generate message screenshots on /for/research #30016

Closed
alya opened this issue May 8, 2024 · 2 comments · Fixed by #30061
Closed

Script to auto-generate message screenshots on /for/research #30016

alya opened this issue May 8, 2024 · 2 comments · Fixed by #30061

Comments

@alya
Copy link
Contributor

alya commented May 8, 2024

At present, we manually generate screenshots on /for/research (and other landing pages), which makes them difficult to maintain. The UI in these screenshots is currently quite out of date. We should write a script to automate how the message screenshots are generated.

The script should be structured so that it's easy to:

  • Extend it to screenshots on other pages. (Some will require a content pass, so let's get one page done first.)
  • Update character names, channel names, topic names, and message content without having to think much about the code.

Notes:

  • Use tools/generate-integration-docs-screenshot as a starting point. zilencer/management/commands/add_mock_conversation.py may also be helpful, but does not currently run.
  • Keep the message content, topics and channels the same as we have in the screenshots now. You can use placeholders for the profile images; I expect we'll update those. The senders should not be bots, of course.
  • This is just for the message screenshots, not the streams (a.k.a. channels) and topics screenshot, which we'll be redoing separately in Figma.
Screenshots to update

image
image

@zulipbot
Copy link
Member

zulipbot commented May 8, 2024

Hello @zulip/server-misc members, this issue was labeled with the "area: portico" label, so you may want to check it out!

@alya
Copy link
Contributor Author

alya commented May 8, 2024

@roanster007 Are you interested in picking up this one? Assigning it to you for now, but feel free to unassign yourself if it doesn't seem like a good fit.

roanster007 added a commit to roanster007/zulip that referenced this issue May 11, 2024
Previously, we manually generated screenshots on /for/research
and other landing pages, which makes them difficult to maintain.

This PR adds a script - generate-user-messages-screenshot, which
expects the path of the filename containing the thread conversation
and path where screenshot needs to be generated, and generates
screenshot at the mentioned location.

Fixes zulip#30016
roanster007 added a commit to roanster007/zulip that referenced this issue May 11, 2024
Previously, we manually generated screenshots for pages like
/for/research and other landing pages, which makes them
difficult to maintain.

This commit adds a script - "generate-user-messages-screenshot",
which expects the path of the filename containing the thread
conversation containing the data of the messages and path
where screenshot needs to be generated, and generates
screenshot at the mentioned location.

Fixes zulip#30016
roanster007 added a commit to roanster007/zulip that referenced this issue May 11, 2024
This commit utilizes the script added for auto-generating
screenshots of message threads to generate screenshots
for the "/for/recovery" page.

This commit adds the message data for generating the
screenshots.

Fixes zulip#30016
roanster007 added a commit to roanster007/zulip that referenced this issue May 13, 2024
Previously, we manually generated screenshots on /for/research
and other landing pages, which makes them difficult to maintain.

This PR adds a script - generate-user-messages-screenshot, which
expects the path of the filename containing the thread conversation
and path where screenshot needs to be generated, and generates
screenshot at the mentioned location.

Fixes zulip#30016
roanster007 added a commit to roanster007/zulip that referenced this issue May 13, 2024
This commit utilizes the script added for auto-generating
screenshots of message threads to generate screenshots
for the "/for/recovery" page.

This commit adds the message data for generating the
screenshots.

Fixes zulip#30016
roanster007 added a commit to roanster007/zulip that referenced this issue May 14, 2024
Previously, we manually generated screenshots on /for/research
and other landing pages, which makes them difficult to maintain.

This PR adds a script - generate-user-messages-screenshot, which
expects the path of the filename containing the thread conversation
and path where screenshot needs to be generated, and generates
screenshot at the mentioned location.

Fixes zulip#30016
timabbott pushed a commit that referenced this issue May 14, 2024
Previously, we manually generated screenshots on /for/research
and other landing pages, which makes them difficult to maintain.

This PR adds a script - generate-user-messages-screenshot, which
expects the path of the filename containing the thread conversation
and path where screenshot needs to be generated, and generates
screenshot at the mentioned location.

Fixes #30016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants