Skip to content

Fix 404 redirects for documentation site#177

Merged
JakeSCahill merged 8 commits into
mainfrom
fix/404-redirects
May 27, 2026
Merged

Fix 404 redirects for documentation site#177
JakeSCahill merged 8 commits into
mainfrom
fix/404-redirects

Conversation

@JakeSCahill
Copy link
Copy Markdown
Contributor

Summary

This PR fixes multiple 404 redirect issues that were causing a high volume of errors on the documentation site.

Changes

1. Fixed /connect/about/ redirect (High Priority)

  • Problem: The /blog/* redirect pointed to /connect/about/, which doesn't exist
  • Fix: Changed redirect target to /connect/home/, which is the actual Connect component home page
  • Impact: Fixes the most frequent 404 error affecting many users

2. Added version root redirects

  • Problem: Version root paths like /23.3/, /24.1/, etc. had no redirects and returned 404s
  • Fix: Added redirects for versions 23.3, 24.1, 24.2, 24.3, 25.1, 25.2, 25.3 to their respective streaming component homes
  • Impact: Improves discoverability and fixes 404s for users accessing version roots

3. Enhanced old version coverage

  • Problem: Old streaming version paths like /streaming/23.1/* only had specific redirects, not catch-alls
  • Fix: Added catch-all redirects for /streaming/23.1/*, /streaming/23.2/*, /streaming/22.x/*, /streaming/21.11/* to /streaming/current/
  • Impact: Reduces 404s from old version pages by providing comprehensive redirect coverage

Testing

After deployment, verify:

  1. /connect/about and /connect/about/ redirect to /connect/home/
  2. Version roots like /23.3, /24.1, /25.3 redirect to their streaming homes
  3. Old version pages like /streaming/23.1/manage/cluster-maintenance/cluster-balancing/ redirect to their current equivalents

Files Modified

  • netlify.toml - Added 72 lines of redirect rules

- Fix /blog/* redirect to point to /connect/home/ instead of non-existent /connect/about/
- Add version root redirects for 23.3, 24.1, 24.2, 24.3, 25.1, 25.2, 25.3 to their streaming component homes
- Add catch-all redirects for old streaming version paths (23.1, 23.2, 22.x, 21.11) to streaming/current
@JakeSCahill JakeSCahill requested a review from a team as a code owner May 27, 2026 08:07
@netlify
Copy link
Copy Markdown

netlify Bot commented May 27, 2026

Deploy Preview for redpanda-documentation ready!

Name Link
🔨 Latest commit 3f3356d
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-documentation/deploys/6a17041e76a6160008acc28b
😎 Deploy Preview https://deploy-preview-177--redpanda-documentation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 80 (🟢 up 8 from production)
Accessibility: 93 (🔴 down 2 from production)
Best Practices: 100 (no change from production)
SEO: 83 (🔴 down 9 from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

JakeSCahill and others added 3 commits May 27, 2026 09:52
- Update all playbooks to use latest UI bundle release URL
- Enable announcement banner in antora-playbook.yml and preview-antora-playbook.yml
- local-antora-playbook.yml already had announcements enabled
Copy link
Copy Markdown
Contributor

@micheleRP micheleRP left a comment

Choose a reason for hiding this comment

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

Review

Approving — the redirect targets are correct, the new catch-alls cover real 404 sources, and the /blog/*/connect/home/ fix addresses the highest-volume case. Verified that /connect/home/ exists (lines 79–80 and 95–96 of netlify.toml already reference it) and that the new /streaming/X/* catch-alls don't duplicate the existing bare /X/* redirects further down.

Heads-up (not blocking)

  1. Netlify deploy preview is failing on commit 1bcc5ff (deploy log). Worth a quick look before merging in case the build failure is related to the latest UI bundle URL change or the re-enabled serve-markdown edge function.
  2. UI bundle URL moved from a pinned release (v3.0.0-beta.23) to releases/latest/download/ui-bundle.zip. latest currently resolves to v3.0.0 (released yesterday). This is a workflow shift worth being aware of — future docs-ui releases will deploy without an explicit docs-site PR. Combined with snapshot: true, every build will pull the newest bundle. Fine if intentional; just calling it out so it's not a surprise the first time a UI release breaks something.
  3. Description nit — the body says catch-all redirects were added for "23.1, 23.2, 22.x, 21.11"; the diff actually adds six specific versions (21.11, 22.1, 22.2, 22.3, 23.1, 23.2). Worth updating for accuracy.
  4. Optional follow-up: bare version roots are redirected for supported versions (/25.3/streaming/25.3/home/) but not for EOL versions (/22.1, /21.11, etc.). If /24.1 was 404ing, /22.1 likely is too. Easy follow-up if it shows up in the next round of friction data.

What works well

  • The split of redirect targets is sensible — supported versions go to their version-specific home, EOL versions collapse to /streaming/current/.
  • 301 status code is right for permanent redirects.
  • The new /streaming/<v>/* catch-alls fill in a real gap (existing redirects only covered the bare /<v>/* paths).
  • The /connect/about//connect/home/ fix targets a legitimately broken redirect.

JakeSCahill and others added 4 commits May 27, 2026 14:17
Add bare root redirects for EOL versions (23.2, 23.1, 22.3, 22.2, 22.1, 21.11) to streaming/current/home/, matching the pattern used for supported versions.
Fetch and inject chat-panel-bump.html widget to enable the Ask AI
drawer on Bump.sh API documentation pages.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Offset chat panel top to account for fixed navbar height
- Add dark mode styles using html[data-theme="dark"] selector
  (Bump pages use this attribute, not .dark-theme class)
- Ensure chat panel icons are visible via stroke/fill fixes

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@JakeSCahill JakeSCahill merged commit f99916d into main May 27, 2026
5 checks passed
@JakeSCahill JakeSCahill deleted the fix/404-redirects branch May 27, 2026 14:54
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.

2 participants