Skip to content

Conversation

@vishvamsinh28
Copy link
Contributor

@vishvamsinh28 vishvamsinh28 commented Nov 28, 2025

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

Release Notes

  • Updates

    • Updated the default specification URL for the generator and multiple templates to a new AsyncAPI community URL.
  • Documentation

    • Updated example URLs in documentation and blog posts to reflect the new specification URL.
  • Infrastructure

    • Added URL redirect support for the new specification URL format.

✏️ Tip: You can customize this high-level summary in your review settings.

@netlify
Copy link

netlify bot commented Nov 28, 2025

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit f64e633
🔍 Latest deploy log https://app.netlify.com/projects/asyncapi-website/deploys/693f85f618756f0008299861
😎 Deploy Preview https://deploy-preview-4647--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 28, 2025

Walkthrough

This PR updates the default AsyncAPI specification URL across the website and generator configuration. It replaces the shortened bit.ly URL with a new full URL (asyncapi.com/s/asyncapiv2) in the generator component, configuration files, documentation examples, and blog posts, along with a corresponding redirect rule.

Changes

Cohort / File(s) Change Summary
Generator Configuration
components/GeneratorInstallation.tsx, config/generator-flags.json
Updated default specPath from https://bit.ly/asyncapi to https://asyncapi.com/s/asyncapiv2 across multiple template entries; nodejs-ws-template retains its existing URL.
Documentation
markdown/blog/february-2021-at-asyncapi.md, markdown/docs/tools/generator/usage.md
Replaced bit.ly/asyncapi URLs with https://asyncapi.com/s/asyncapiv2 in code examples and usage documentation.
Infrastructure
public/_redirects
Added 301 redirect rule for /s/asyncapiv2 to raw Streetlights YAML on GitHub under a "short urls" section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Verification points:
    • Confirm all bit.ly URL occurrences have been replaced consistently across files
    • Validate the new URL (asyncapi.com/s/asyncapiv2) is correct and accessible
    • Review the redirect rule syntax and target path in public/_redirects

Possibly related PRs

Suggested labels

ready-to-merge

Suggested reviewers

  • derberg
  • akshatnema
  • sambhavgupta0705
  • TRohit20
  • quetzalliwrites

Poem

🐰 A shorter path once led the way,
But now a clearer link will stay,
From bit.ly's curl to URLs bright,
The AsyncAPI spec shines full light! ✨

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 summarizes the main change: replacing bit.ly URLs with Netlify redirects across multiple files (components, config, docs, and redirect rules).
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4094d22 and eab3b83.

📒 Files selected for processing (5)
  • components/GeneratorInstallation.tsx (1 hunks)
  • config/generator-flags.json (1 hunks)
  • markdown/blog/february-2021-at-asyncapi.md (2 hunks)
  • markdown/docs/tools/generator/usage.md (1 hunks)
  • public/_redirects (1 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: anshgoyalevil
Repo: asyncapi/website PR: 3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: bandantonio
Repo: asyncapi/website PR: 3393
File: markdown/blog/2024-Q1-docs-report.md:10-12
Timestamp: 2024-11-13T20:34:18.998Z
Learning: In the markdown files for the AsyncAPI website, avatar image paths should be referenced without the `public` prefix (e.g., use `/img/avatars/...` instead of `/public/img/avatars/...`).
Learnt from: bandantonio
Repo: asyncapi/website PR: 4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
Learnt from: anshgoyalevil
Repo: asyncapi/website PR: 3557
File: tests/markdown/check-edit-links.test.js:20-46
Timestamp: 2025-01-14T14:58:38.076Z
Learning: In the AsyncAPI website codebase, the edit-page-config.json contains a fallback match entry that ensures determineEditLink function always has a valid target.value, making null checks unnecessary.
📚 Learning: 2025-01-19T04:51:41.255Z
Learnt from: anshgoyalevil
Repo: asyncapi/website PR: 3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.

Applied to files:

  • components/GeneratorInstallation.tsx
  • config/generator-flags.json
📚 Learning: 2025-01-18T08:44:43.614Z
Learnt from: akshatnema
Repo: asyncapi/website PR: 3423
File: tests/index.test.js:2-7
Timestamp: 2025-01-18T08:44:43.614Z
Learning: In the AsyncAPI website project, JavaScript test files must include the .ts extension when importing TypeScript files (e.g., `require('../scripts/build-rss.ts')`). This is a project-specific requirement enforced by the linting rules and build setup, even though it differs from typical Node.js behavior.

Applied to files:

  • config/generator-flags.json
📚 Learning: 2025-07-19T20:58:34.040Z
Learnt from: bandantonio
Repo: asyncapi/website PR: 4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.

Applied to files:

  • config/generator-flags.json
🪛 LanguageTool
markdown/blog/february-2021-at-asyncapi.md

[style] ~44-~44: Consider using “unable” to avoid wordiness.
Context: ...-template). The initial contributor was not able to continue working on the template, bu...

(NOT_ABLE_PREMIUM)

⏰ Context from checks skipped due to timeout of 180000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: cypress-run
  • GitHub Check: Lighthouse CI
🔇 Additional comments (5)
components/GeneratorInstallation.tsx (1)

27-27: LGTM!

The URL update is correct and aligns with the new redirect configuration in public/_redirects.

public/_redirects (1)

73-75: LGTM! Consider the versioning strategy.

The redirect configuration is correct. The path /s/asyncapiv2 appropriately indicates it points to AsyncAPI v2 specification example, and the hardcoded 2.0.0 version in the target URL is intentional for stability. Users relying on this URL will consistently get the same example version.

markdown/docs/tools/generator/usage.md (1)

48-48: LGTM!

Documentation example correctly updated to use the new URL.

markdown/blog/february-2021-at-asyncapi.md (1)

39-39: LGTM!

All three URL updates in the blog post code examples are correct and consistent with the new redirect configuration.

Also applies to: 47-47, 157-157

config/generator-flags.json (1)

4-4: The redirect target is correct and matches the original bit.ly destination.

The web search confirms that bit.ly/asyncapi redirects to https://raw.githubusercontent.com/asyncapi/asyncapi/2.0.0/examples/2.0.0/streetlights.yml, which is exactly the URL now hardcoded in the configuration. The URL is accessible and contains valid AsyncAPI 2.0.0 Streetlights example specification content. The changes are verified and safe.

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Nov 28, 2025

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 38
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-4647--asyncapi-website.netlify.app/

@codecov
Copy link

codecov bot commented Nov 28, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (9c3dcd6) to head (f64e633).

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #4647   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           22        22           
  Lines          799       799           
  Branches       146       146           
=========================================
  Hits           799       799           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Member

@princerajpoot20 princerajpoot20 left a comment

Choose a reason for hiding this comment

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

LGTM!

@princerajpoot20
Copy link
Member

@vishvamsinh28 Can you please do one thing? Please attach the testing evidence in the issue, just to make sure everything looks good. Thanks.

@princerajpoot20
Copy link
Member

/rtm

@princerajpoot20
Copy link
Member

@TRohit20 PTAL

@derberg
Copy link
Member

derberg commented Dec 11, 2025

@TRohit20 @thulieblack you need to approve as well as there are markdown files

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.

4 participants