Skip to content

DOC-7128 embeds-oss: convert embeds/ and oss_and_stack/ images - #4189

Merged
andy-stark-redis merged 1 commit into
mainfrom
DOC-7128-embeds-oss
Oct 2, 2026
Merged

andy-stark-redis merged 1 commit into
mainfrom
DOC-7128-embeds-oss

Conversation

@andy-stark-redis

@andy-stark-redis andy-stark-redis commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Converts the image shortcodes in content/embeds/ and content/operate/oss_and_stack/ to Markdown images, using the codemod from #4151. Part of DOC-7128.

Counts: 89 images converted in 35 files. 21 shortcodes stay as shortcodes, because the codemod can't convert them safely. Most are in rs-observability.md and tls-configuration-procedure.md, where an image follows a list step with no blank line in between, so it shares a paragraph with the text. There's also one inline icon, plus a timeseries table line holding two images.

Moved images: the 7 Triggers and Functions screenshots used by Quick_Start_RI.md lived in an images/ folder under content/, which the codemod won't convert. They move to static/images/triggers-and-functions/, as polygons.png did in #4152. Nothing else referenced them, and their old URLs stop being published.

Embeds: an embed renders inside every page that includes it, including archived version pages. So the build comparison checked the converted embeds through those pages.

Dead embed files (flagged, not deleted): content/embeds/ never renders as pages of its own (build: render: never), and these four aren't included anywhere: account-role-table.html, rc-create-db-use-cases.md, rc-version-upgrade.md, and tls-configuration-procedure.md. The last three are converted here, but can't be render-verified. account-role-table.html has 36 raw <img> tags with ../ paths, and I've left them alone because they never render. All four look like candidates for deletion in a separate change.

Verification

  • Built main and this branch under the production baseURL (/docs/latest/): both succeeded (19,664 pages), and the hook reported no missing images.
  • Compared src/width/alt/class for every image on every page. The only differences are the 7 moved images' src paths. I checked those files: they're byte-identical to the originals, and published at their new URLs.
  • Coverage: oss_and_stack/ has 43 source shortcodes, and all 43 render on main, so the comparison saw every one. Site-wide, rendered sdata-lightbox wrappers drop from 691 to 450, because each converted embed renders on every page that includes it.
  • Counts reconcile: 110 shortcodes before, 89 converted, 21 left, and 89 deleted lines. No file outside the list was touched.
  • AI Markdown feed (whole site): no attribute lines and no relative /images/ links. Absolute image URLs go from 2,081 to 2,088, which is the 7 moved images now under /images/.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only markup and static asset path changes; no application, auth, or data-handling code is affected.

Overview
Replaces Hugo {{< image >}} shortcodes with standard Markdown images across content/embeds/ and content/operate/oss_and_stack/ (89 conversions in 35 files), using absolute /images/... paths and moving width, class, and similar options to attribute lines on the line after the image where the codemod supports it.

Triggers and Functions screenshots referenced by Quick_Start_RI.md are relocated from under content/ to static/images/triggers-and-functions/, with markdown src updated accordingly. 21 shortcodes are intentionally unchanged (e.g. inline UI icons in tls-configuration-procedure.md, many dashboard images still shortcoded in rs-observability.md).

No product or API behavior changes—this is a docs build/markdown migration aligned with prior codemod work (#4151).

Reviewed by Cursor Bugbot for commit fca8e94. Bugbot is set up for automated code reviews on this repo. Configure here.

Runs build/migrate_image_shortcodes.py over content/embeds/ and
content/operate/oss_and_stack/, converting 89 image shortcodes to Markdown
images. 21 that the codemod can't convert safely stay as shortcodes. Embeds
render inside every page that includes them, including archived version
pages, so the build comparison checked them through those pages: no image
attributes changed anywhere except the moved images.

The 7 Triggers and Functions screenshots used by Quick_Start_RI.md lived in a
content/ images/ folder, which the codemod won't convert. They move to
static/images/triggers-and-functions/, as polygons.png did in #4152. The files
are byte-identical, nothing else referenced them, and the old URLs stop being
published.

Four embeds are dead: content/embeds/ never renders as pages (build: render:
never), and nothing includes account-role-table.html,
rc-create-db-use-cases.md, rc-version-upgrade.md, or tls-configuration-procedure.md.
Three of those are converted here but can't be render-verified.
account-role-table.html's 36 raw <img> tags with ../ paths are left alone,
because they never render.

Gaps: the converted dead embeds (rc-create-db-use-cases, rc-version-upgrade, tls-configuration-procedure) could not be render-verified
Ticket: DOC-7128
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

DOC-7128

@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

🧠 Redis Memory

Found 5 related items from repository history (5 new this commit):

Memory updated at fca8e94

@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

Staging links:
https://redis.io/docs/staging/DOC-7128-embeds-oss/integrate/dynatrace-with-redis-cloud/
https://redis.io/docs/staging/DOC-7128-embeds-oss/integrate/new-relic-with-redis-cloud/
https://redis.io/docs/staging/DOC-7128-embeds-oss/integrate/prometheus-with-redis-cloud/
https://redis.io/docs/staging/DOC-7128-embeds-oss/integrate/prometheus-with-redis-enterprise/
https://redis.io/docs/staging/DOC-7128-embeds-oss/integrate/prometheus-with-redis-enterprise/observability
https://redis.io/docs/staging/DOC-7128-embeds-oss/integrate/redis-data-integration/1.19.1/installation/install-k8s
https://redis.io/docs/staging/DOC-7128-embeds-oss/integrate/redis-data-integration/1.19.1/installation/install-vm
https://redis.io/docs/staging/DOC-7128-embeds-oss/integrate/redis-data-integration/1.19.1/installation/reqsummary
https://redis.io/docs/staging/DOC-7128-embeds-oss/integrate/redis-data-integration/1.19.1/quick-start-guide
https://redis.io/docs/staging/DOC-7128-embeds-oss/integrate/redis-data-integration/installation/install-k8s
https://redis.io/docs/staging/DOC-7128-embeds-oss/integrate/redis-data-integration/installation/install-vm
https://redis.io/docs/staging/DOC-7128-embeds-oss/integrate/redis-data-integration/installation/reqsummary
https://redis.io/docs/staging/DOC-7128-embeds-oss/integrate/redis-data-integration/quick-start-guide
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/oss_and_stack/stack-with-enterprise/bloom/
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/install/
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/install/
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/graph-quickstart/
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Quick_Start_RI/
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database/
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module/
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/oss_and_stack/stack-with-enterprise/json/active-active/
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-2.0-release-notes/
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/oss_and_stack/stack-with-enterprise/release-notes/redistimeseries/redistimeseries-1.8-release-notes/
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/billing-and-payments/
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/billing-and-payments/cost-report
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/changelog/2023/october-2023
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/changelog/2023/september-2023
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/changelog/may-2026
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/cloud-integrations/aws-marketplace/
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/cloud-integrations/gcp-marketplace/
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/databases/active-active/create-active-active-database
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/databases/active-active/manage-regions
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/databases/connect/
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/databases/create-database/create-essentials-database
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/databases/create-database/create-flex-database
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/databases/create-database/create-free-database
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/databases/create-database/create-pro-database-existing
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/databases/create-database/create-pro-database-new
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/databases/monitor-performance
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/databases/redirect-endpoints
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/databases/tag-database
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/logs-reports/usage-reports
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/rdi/create-workspace
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rc/rdi/quick-start
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/7.22/databases/import-export/replica-of/create
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/7.22/installing-upgrading/quickstarts/docker-quickstart
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/7.22/installing-upgrading/quickstarts/redis-enterprise-software-quickstart
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/7.22/monitoring/observability
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/7.22/monitoring/prometheus_and_grafana
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/7.22/security/encryption/tls/enable-tls
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/7.4/databases/import-export/replica-of/create
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/7.4/installing-upgrading/quickstarts/docker-quickstart
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/7.4/security/encryption/tls/enable-tls
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/7.8/databases/import-export/replica-of/create
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/7.8/installing-upgrading/quickstarts/docker-quickstart
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/7.8/installing-upgrading/quickstarts/redis-enterprise-software-quickstart
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/7.8/monitoring/observability
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/7.8/monitoring/prometheus_and_grafana
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/7.8/security/encryption/tls/enable-tls
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/8.0/databases/import-export/replica-of/create
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/8.0/installing-upgrading/quickstarts/docker-quickstart
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/8.0/installing-upgrading/quickstarts/redis-enterprise-software-quickstart
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/8.0/monitoring/observability
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/8.0/security/encryption/tls/enable-tls
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/databases/import-export/replica-of/create
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/installing-upgrading/quickstarts/docker-quickstart
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/monitoring/observability
https://redis.io/docs/staging/DOC-7128-embeds-oss/operate/rs/security/encryption/tls/enable-tls

@dwdougherty dwdougherty left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTC.

@andy-stark-redis
andy-stark-redis merged commit eaefa1d into main Oct 2, 2026
100 checks passed
@andy-stark-redis
andy-stark-redis deleted the DOC-7128-embeds-oss branch October 2, 2026 13:54
andy-stark-redis added a commit that referenced this pull request Oct 2, 2026
…plit the april-2025 toggles)

The hook now marks an image img-inline only when it's inline, local, AND
carries #no-click. Before, any local image sharing a paragraph with text
qualified, so a future screenshot written directly under a line of text, with
no blank line, would have silently shrunk to text height. Every converted icon
already has #no-click, so none of them change.

The light and dark mode toggles in rc/changelog/april-2025.md were a paragraph
of their own, joined by &nbsp;, so the codemod treated the pair as inline icons
and they dropped from 149x57 to about 63x24. They're now two standalone images
separated by a blank line, back at their natural size. The &nbsp; had to go
too: an image followed by &nbsp; isn't alone in its paragraph, so it would
have stayed inline. As block images they stack rather than sit side by side.

Merged main first, which brings in #4189's conversion of the
tls-configuration-procedure.md screenshot the review asked about.

Learned: an image that ends its line with &nbsp; isn't alone in its paragraph, so a blank line alone won't make it a block image
Constraint: render-image.html adds img-inline only to inline, local, #no-click images; a screenshot sharing a paragraph with text must stay full size
Ticket: DOC-7128
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
EliShteinman added a commit to EliShteinman/docs that referenced this pull request Oct 3, 2026
Converts the embeds and oss_and_stack image shortcodes to Markdown images and moves the Triggers and Functions screenshots to static/images.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants