Repository navigation
DOC-7128 unit 1: convert develop/ image shortcodes to Markdown images - #4152
Merged
Merged
Conversation
Contributor
Contributor
🧠 Redis MemoryFound 7 related items from repository history (2 new this commit):
Memory updated at eeef765 |
Contributor
dwdougherty
approved these changes
Sep 29, 2026
dwdougherty
left a comment
dwdougherty
left a comment
Collaborator
There was a problem hiding this comment.
I tested a few random pages. All LGTM.
Runs build/migrate_image_shortcodes.py over content/develop/ (23 files, 104 images, all of them convertible). Also moves polygons.png, the only image query_syntax.md uses, from content/develop/ai/search-and-query/img/ to static/images/dev/rqe/, next to the geo page's geoshapes.jpg. The codemod only converts images that live in static/, and a page-relative path would not resolve because query_syntax.md is not a page bundle. The old URL stops being published; nothing else in the repo referenced it. content/develop/ai/redisvl/ (19 copies of one architecture diagram) is left out on purpose. build/redisvl_docs_sync.py writes that shortcode itself, so converting the files by hand would be undone on the next sync. Verified by building unit 0 and this branch under the production baseURL and comparing img src/width/alt/class on every page: only two images change, both intended (insight-stream-consumer's broken /docs/images path fixed, and polygons.png at its new location). Directive: convert redisvl/ images by changing the _IMAGE_STATIC replacement in build/redisvl_docs_sync.py, not by editing the synced files Ticket: DOC-7128 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
andy-stark-redis
force-pushed
the
DOC-7128-unit1-develop
branch
from
September 29, 2026 15:18
909b165 to
eeef765
Compare
EliShteinman
added a commit
to EliShteinman/docs
that referenced
this pull request
Sep 29, 2026
Converts the image shortcodes in content/develop/ to Markdown images and moves polygons.png into static/images.
EliShteinman
added a commit
to EliShteinman/docs
that referenced
this pull request
Sep 29, 2026
Converts the image shortcodes in content/develop/ to Markdown images and moves polygons.png into static/images.
This was referenced Oct 1, 2026
Contributor
Author
|
Thanks @dwdougherty ! |
This was referenced Oct 2, 2026
andy-stark-redis
added a commit
that referenced
this pull request
Oct 2, 2026
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, archived version pages among them, so the build comparison checked them through those pages: no image attributes changed 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. content/embeds/ never renders as pages (build: render: never), and four files in it are included nowhere: account-role-table.html, rc-create-db-use-cases.md, rc-version-upgrade.md, and tls-configuration-procedure.md. The three Markdown ones 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>
This was referenced Oct 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Converts the
imageshortcodes incontent/develop/to Markdown images, using the render hook and codemod from #4151 (merged). Unit 1 of DOC-7128.Counts: 23 files, 104 images converted, 0 image shortcodes left in scope. Of the 104, 78 bare paths (
images/...) and 1 dot-relative path were rewritten to site-root/images/....Moved image:
polygons.png, the only imagequery_syntax.mduses, moves fromcontent/develop/ai/search-and-query/img/tostatic/images/dev/rqe/, next to the geo page'sgeoshapes.jpg. No other page referenced it. Its old URL is no longer published.Not included:
content/develop/ai/redisvl/(19 copies of one architecture diagram).build/redisvl_docs_sync.pywrites that shortcode itself, so converting the files by hand would be undone on the next sync. That needs a change to the sync script instead.Verification
/docs/latest/): both succeeded, 19,661 pages each, with no missing-image warnings from the hook.src/width/alt/classfor every image on every page. Only 2 images change, both intended:develop/tools/insight/insight-stream-consumer:/docs/images/ri/ri-streams-cg.pngbecomes/docs/latest/images/ri/ri-streams-cg.png. The old path is broken in production today.query_syntax:polygons.pngat its new location.develop/: no attribute lines and no relative/images/links remain.🤖 Generated with Claude Code
Note
Low Risk
Documentation-only markup and static asset path changes; intended URL fixes with no application or security impact.
Overview
Unit 1 of DOC-7128 replaces Hugo
{{< image >}}shortcodes with standard Markdown images across 23 files undercontent/develop/(104 figures), so they render through the image render hook from #4151.Each conversion uses
with site-root paths (bareimages/...and dot-relative URLs normalized). Where shortcodes hadwidth, that moves to a separate{width="..."}line. Prose is unchanged aside from these embeds.Asset fix:
polygons.pngmoves fromcontent/develop/ai/search-and-query/img/tostatic/images/dev/rqe/(alongsidegeoshapes.jpg).insight-stream-consumerfixes a brokenri-streams-cg.pngURL for production/docs/latest/.Out of scope:
content/develop/ai/redisvl/still uses shortcodes because the sync script regenerates them.Reviewed by Cursor Bugbot for commit eeef765. Bugbot is set up for automated code reviews on this repo. Configure here.