paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-02 21:13:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

tools: Add help text to generate-user-messages-screenshot.

Browse Source 
Adds general help description text for the tool that generates
cropped message screenshots for corporate pages.

Notes some of the known issues when updating these screenshots
after there have been UI changes, such as partial dates showing
and truncated channel/topic names in screenshots.
This commit is contained in:
Lauryn Menard
2025-08-14 17:25:37 +02:00
committed by Tim Abbott
parent 3096d7ec51
commit cd4cc1a4b1
1 changed files with 24 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
tools/screenshots/generate-user-messages-screenshot
View File

@@ -217,7 +217,30 @@ def capture_streams_narrow_screenshot(
)
parser = argparse.ArgumentParser()
DESCRIPTION = """
Generate screenshots of messages for corporate pages.
This script takes a json file with conversation details, and runs
tools/thread-screenshot.js to take cropped screenshots of the
generated messages with puppeteer.
Make sure you have the dev environment up and running in a separate
terminal window when you run the script.
Note that you will often want to update the content of existing
json files (e.g., tools/screenshots/for-events.json) when you are
taking updated screenshots. For example, updating any dates for
the current year is recommended.
Also, note that you may need to adjust the viewport width in the
puppeteer code and/or update the channel or topic names in the json
content so that message header bars don't have truncated (...)
channel or topic names due to web app UI changes.
"""
parser = argparse.ArgumentParser(
description=DESCRIPTION, formatter_class=argparse.RawTextHelpFormatter
)
group = parser.add_mutually_exclusive_group(required=True)
group.add_argument(