Skip to content

Conversation

@CamSoper
Copy link
Contributor

Summary

Fixes broken image references in two Insights Discovery documentation pages that were affected by the recent docs reorganization.

Root Cause

Both pages were moved from /docs/insights/ to /docs/insights/discovery/ but their image paths were not updated:

  • visual-import.md: Used relative paths like import-left-nav.png pointing to the old /import/ location
  • data-export.md: Used relative path ../assets/data-export-pulumi-cloud-ui.png which resolved to the wrong directory (/docs/insights/discovery/assets/ instead of /docs/insights/assets/)

Changes

  • Moved 5 visual import images from content/docs/insights/import/ to content/docs/insights/assets/ using git mv to preserve history
  • Updated 6 image references to use absolute paths (/docs/insights/assets/*.png)
  • Removed the now-empty content/docs/insights/import/ directory
  • This matches the pattern used by all other Insights documentation

Affected Pages

  • /docs/insights/discovery/visual-import/ (5 images fixed)
  • /docs/insights/discovery/data-export/ (1 image fixed)

Testing

  • make lint passes
  • make build succeeds
  • ✅ All images now load correctly in the built output

Fixes #16315

🤖 Generated with Claude Code

This change fixes broken image references in two Insights Discovery
documentation pages that were affected by the recent docs reorganization.

Root cause:
- visual-import.md and data-export.md were moved from /docs/insights/
  to /docs/insights/discovery/ but their image paths were not updated
- visual-import.md used relative paths pointing to the old /import/ location
- data-export.md used a relative path that resolved to the wrong directory

Changes:
- Moved 5 visual import images from content/docs/insights/import/ to
  content/docs/insights/assets/ using git mv to preserve history
- Updated 6 image references to use absolute paths (/docs/insights/assets/)
- Removed the now-empty content/docs/insights/import/ directory
- This matches the pattern used by all other Insights documentation

Affected pages:
- /docs/insights/discovery/visual-import/ (5 images fixed)
- /docs/insights/discovery/data-export/ (1 image fixed)

Fixes #16315

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
Copy link
Contributor

claude bot commented Oct 18, 2025

Review Summary

This PR successfully fixes broken image references in the Insights Discovery documentation. The changes are clean, well-documented, and follow repository conventions. ✅

What Was Done Well

  1. Proper use of git mv to preserve file history when moving images
  2. Absolute path references (/docs/insights/assets/*.png) - matches the pattern used elsewhere in Insights docs
  3. Consolidates assets into a single location (content/docs/insights/assets/) rather than scattered subdirectories
  4. Clear root cause analysis in the PR description explaining why the images broke
  5. Testing performed - lint and build checks confirmed

Issues Found

None - the PR meets all quality standards.

Technical Details Verified

  • ✅ All 6 image path updates use correct absolute paths
  • ✅ Images moved from content/docs/insights/import/ to content/docs/insights/assets/
  • ✅ Alt text is descriptive (e.g., "a screenshot of the Pulumi Cloud web UI showing...")
  • ✅ Markdown formatting is correct
  • ✅ Files end with newlines (data-export.md:26, visual-import.md:84)
  • ✅ No style guide violations detected

Files Reviewed

  • content/docs/insights/discovery/data-export.md (line 25)
  • content/docs/insights/discovery/visual-import.md (lines 39, 53, 69, 78, 84)
  • 5 image files moved to content/docs/insights/assets/

Need another review? Tag me with @claude-code /docs-review or use the /docs-review slash command after making changes.

@pulumi-bot
Copy link
Collaborator

@CamSoper CamSoper enabled auto-merge (squash) October 18, 2025 00:29
@CamSoper CamSoper merged commit fca908f into master Oct 18, 2025
9 checks passed
@CamSoper CamSoper deleted the CamSoper/issue16315 branch October 18, 2025 00:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

All images are broken in /docs/insights/discovery/ and /docs/insights/discovery/visual-import/

4 participants