feat: replace bitly urls with netlify redirect
This PR replaces all bit.ly short URLs with /s path, using Netlify’s _redirects functionality. All occurrences across the codebase have been updated accordingly.
part of #3005
Summary by CodeRabbit
-
Updates
- Updated the default specification URL used by the generator and several templates to the new AsyncAPI community URL.
-
Documentation
- Replaced shortened example URLs with the new AsyncAPI URL across docs and a blog post.
-
Infrastructure
- Added a redirect entry to support the new short URL path.
✏️ Tip: You can customize this high-level summary in your review settings.
Deploy Preview for asyncapi-website ready!
Built without sensitive environment variables
| Name | Link |
|---|---|
| Latest commit | 78faa40e2ee7850759f0ddf34a6db4771344194d |
| Latest deploy log | https://app.netlify.com/projects/asyncapi-website/deploys/6948ccbed8069d0008a84638 |
| Deploy Preview | https://deploy-preview-4647--asyncapi-website.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify project configuration.
Walkthrough
Replaced the shortened spec URL https://bit.ly/asyncapi with https://asyncapi.com/s/asyncapiv2 across generator UI defaults, generator flag config, documentation examples, a blog post, and added a corresponding redirect entry.
Changes
| Cohort / File(s) | Change Summary |
|---|---|
Generator component & flags components/GeneratorInstallation.tsx, config/generator-flags.json |
Updated default specPath/template URLs from https://bit.ly/asyncapi to https://asyncapi.com/s/asyncapiv2 for multiple templates. |
Documentation & blog examples markdown/docs/tools/generator/usage.md, markdown/blog/february-2021-at-asyncapi.md |
Replaced bit.ly/asyncapi usages with https://asyncapi.com/s/asyncapiv2 in code examples and usage instructions. |
Redirects / infra public/_redirects |
Added # Short URLs section and a 301 redirect entry mapping /s/asyncapiv2 to the Streetlights YAML example URL. |
Estimated code review effort
🎯 2 (Simple) | ⏱️ ~10 minutes
- Pay attention to:
- Any remaining
bit.ly/asyncapioccurrences across repo. - Correctness and formatting of the
public/_redirects301 redirect and header line. - Generator commands/examples reflect the new URL (copy/paste validation).
- Any remaining
Possibly related PRs
- asyncapi/website#3785 — Modifies generator usage docs (
markdown/docs/tools/generator/usage.md); related documentation editing.
Suggested labels
ready-to-merge
Suggested reviewers
- derberg
- TRohit20
- akshatnema
- thulieblack
- princerajpoot20
Poem
🐰 I hopped through links with nimble cheer,
Short paths swapped so examples steer.
From bit.ly to steady ground,
A rabbit’s nudge — the URLs found. 🥕
Pre-merge checks and finishing touches
✅ Passed checks (3 passed)
| Check name | Status | Explanation |
|---|---|---|
| Description Check | ✅ Passed | Check skipped - CodeRabbit’s high-level summary is enabled. |
| Title check | ✅ Passed | The title accurately describes the main change: replacing bit.ly short URLs with Netlify redirects across the codebase. |
| Docstring Coverage | ✅ Passed | Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. |
✨ Finishing touches
🧪 Generate unit tests (beta)
- [ ] Create PR with unit tests
- [ ] Post copyable unit tests in a comment
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands and usage tips.
⚡️ Lighthouse report for the changes in this PR:
| Category | Score |
|---|---|
| 🔴 Performance | 36 |
| 🟢 Accessibility | 98 |
| 🟢 Best practices | 92 |
| 🟢 SEO | 100 |
| 🔴 PWA | 33 |
Lighthouse ran on https://deploy-preview-4647--asyncapi-website.netlify.app/
Codecov Report
:white_check_mark: All modified and coverable lines are covered by tests.
:white_check_mark: Project coverage is 100.00%. Comparing base (f604d92) to head (78faa40).
:warning: Report is 1 commits behind head on master.
Additional details and impacted files
@@ Coverage Diff @@
## master #4647 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 798 798
Branches 146 146
=========================================
Hits 798 798
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
:rocket: New features to boost your workflow:
- :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
- :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
@vishvamsinh28 Can you please do one thing? Please attach the testing evidence in the issue, just to make sure everything looks good. Thanks.
/rtm
@TRohit20 PTAL
@TRohit20 @thulieblack you need to approve as well as there are markdown files
/rtm
few tests have flaky behavior, re-running the workflow a few times will make these checks pass
lgtm
re-running it
@asyncapi/bounty_team
@thulieblack @TRohit20 please re-review it
/rtm
/rtm
@princerajpoot20 here's the testing evidence for the issue
- Guide on how to add short urls
- Custom short url
https://github.com/user-attachments/assets/fe673b93-076b-40d0-82ba-65133deefb39