fix: corrected href links of Join us and subscribe button #3823
Conversation
dipishBisht
requested review from
Mayaleeeee,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve and
derberg
as code owners
WalkthroughThis pull request updates various components and configuration files. The homepage now derives a Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant HP as HomePage Component
participant Env as Environment
U->>HP: Request Home Page
HP->>Env: Retrieve NEXT_PUBLIC_BASE_URL
Env-->>HP: Return BASE_URL
HP->>Button: Set href (using BASE_URL)
HP->>TextLink: Set href (using BASE_URL)
HP->>SubscribeButton: Set href (absolute URL)
U->>Button: Click to join Slack
Button-->>U: Redirect to external URL
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
pages/[lang]/index.tsx (1)
104-128: Consider using environment variables for base URLsWhile updating to absolute URLs works, hardcoding full URLs can make the code less maintainable when deploying to different environments (development, staging, production).
Consider using environment variables or a configuration file for the base URL:
// Add to a config file or environment setup + const BASE_URL = process.env.NEXT_PUBLIC_BASE_URL || 'https://www.asyncapi.com'; // Then use in components - href='https://www.asyncapi.com/slack-invite' + href={`${BASE_URL}/slack-invite`} - href='https://www.asyncapi.com/community/meetings' + href={`${BASE_URL}/community/meetings`}This approach allows for easier maintenance and flexibility across different environments.
🧰 Tools
🪛 ESLint
[error] 104-104: Replace
·className='w-full·md:w-auto'·text={t('community.slackCTABtn')}·href='https://www.asyncapi.com/slack-invite'with⏎······················className='w-full·md:w-auto'⏎······················text={t('community.slackCTABtn')}⏎······················href='https://www.asyncapi.com/slack-invite'⏎···················(prettier/prettier)
[error] 121-121: Replace
{t('community.meetingLink')}with⏎························{t('community.meetingLink')}⏎······················(prettier/prettier)
[error] 128-128: Replace
·href='https://www.asyncapi.com/community/meetings'·className='mt-2·md:ml-2·md:mt-0'with⏎··························href='https://www.asyncapi.com/community/meetings'⏎··························className='mt-2·md:ml-2·md:mt-0'⏎·······················(prettier/prettier)
🪛 GitHub Actions: PR testing - if Node project
[error] 104-104: Prettier formatting check failed. Replace
className='w-full md:w-auto' text={t('community.slackCTABtn')} href='https://www.asyncapi.com/slack-invite'withclassName='w-full md:w-auto' text={t('community.slackCTABtn')} href='https://www.asyncapi.com/slack-invite'.
[error] 121-121: Prettier formatting check failed. Replace
{t('community.meetingLink')}with{t('community.meetingLink')}.
[error] 128-128: Prettier formatting check failed. Replace
href='https://www.asyncapi.com/community/meetings' className='mt-2 md:ml-2 md:mt-0'withhref='https://www.asyncapi.com/community/meetings' className='mt-2 md:ml-2 md:mt-0'.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/[lang]/index.tsx(2 hunks)
🧰 Additional context used
🪛 ESLint
pages/[lang]/index.tsx
[error] 104-104: Replace ·className='w-full·md:w-auto'·text={t('community.slackCTABtn')}·href='https://www.asyncapi.com/slack-invite' with ⏎······················className='w-full·md:w-auto'⏎······················text={t('community.slackCTABtn')}⏎······················href='https://www.asyncapi.com/slack-invite'⏎···················
(prettier/prettier)
[error] 121-121: Replace {t('community.meetingLink')} with ⏎························{t('community.meetingLink')}⏎······················
(prettier/prettier)
[error] 128-128: Replace ·href='https://www.asyncapi.com/community/meetings'·className='mt-2·md:ml-2·md:mt-0' with ⏎··························href='https://www.asyncapi.com/community/meetings'⏎··························className='mt-2·md:ml-2·md:mt-0'⏎·······················
(prettier/prettier)
🪛 GitHub Actions: PR testing - if Node project
pages/[lang]/index.tsx
[error] 104-104: Prettier formatting check failed. Replace className='w-full md:w-auto' text={t('community.slackCTABtn')} href='https://www.asyncapi.com/slack-invite' with className='w-full md:w-auto' text={t('community.slackCTABtn')} href='https://www.asyncapi.com/slack-invite'.
[error] 121-121: Prettier formatting check failed. Replace {t('community.meetingLink')} with {t('community.meetingLink')}.
[error] 128-128: Prettier formatting check failed. Replace href='https://www.asyncapi.com/community/meetings' className='mt-2 md:ml-2 md:mt-0' with href='https://www.asyncapi.com/community/meetings' className='mt-2 md:ml-2 md:mt-0'.
⏰ Context from checks skipped due to timeout of 180000ms (4)
- GitHub Check: Redirect rules - asyncapi-website
- GitHub Check: Header rules - asyncapi-website
- GitHub Check: Pages changed - asyncapi-website
- GitHub Check: Lighthouse CI
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
components/buttons/SlackButton.tsx (1)
9-9: Remove extra whitespace in interface declaration.The updated interface declaration contains an extra space before the closing curly brace, which causes a Prettier formatting error. Please remove the extra space so that it adheres to the project's style guidelines.
-interface ISlackButtonProps extends IButtonDefaultProps { } +interface ISlackButtonProps extends IButtonDefaultProps {}🧰 Tools
🪛 ESLint
[error] 9-9: Delete
·(prettier/prettier)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/buttons/SlackButton.tsx(1 hunks)
🧰 Additional context used
🪛 ESLint
components/buttons/SlackButton.tsx
[error] 9-9: Delete ·
(prettier/prettier)
⏰ Context from checks skipped due to timeout of 180000ms (1)
- GitHub Check: Test NodeJS PR - macos-13
dipishBisht
changed the title
dipishBisht
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3823 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 21 21
Lines 667 667
Branches 113 113
=========================================
Hits 667 667 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
pages/[lang]/index.tsx (1)
127-129:⚠️ Potential issueFixed community meetings link but formatting needs fixing.
The link update to use the BASE_URL constant is good, but there's a Prettier formatting issue that's causing the pipeline to fail.
Fix the formatting as suggested by Prettier:
- <TextLink href={`${BASE_URL}/community/meetings`}> - {t('community.meetingLink')} - </TextLink> + <TextLink href={`${BASE_URL}/community/meetings`}>{t('community.meetingLink')}</TextLink>🧰 Tools
🪛 ESLint
[error] 127-129: Replace
⏎························{t('community.meetingLink')}⏎······················with{t('community.meetingLink')}(prettier/prettier)
🪛 GitHub Actions: PR testing - if Node project
[error] 127-127: Prettier formatting check failed. Replace
⏎························{t('community.meetingLink')}⏎······················with{t('community.meetingLink')}.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/[lang]/index.tsx(3 hunks)
🧰 Additional context used
🪛 ESLint
pages/[lang]/index.tsx
[error] 127-129: Replace ⏎························{t('community.meetingLink')}⏎······················ with {t('community.meetingLink')}
(prettier/prettier)
🪛 GitHub Actions: PR testing - if Node project
pages/[lang]/index.tsx
[error] 127-127: Prettier formatting check failed. Replace ⏎························{t('community.meetingLink')}⏎······················ with {t('community.meetingLink')}.
🔇 Additional comments (2)
pages/[lang]/index.tsx (2)
36-37: Good addition of a BASE_URL constant.Using a configurable base URL with a fallback default is a good practice that centralizes URL configuration and provides flexibility across different environments.
106-110: Correctly updated Slack invite link.You've appropriately updated the Slack invite link to use the BASE_URL constant, which ensures the link works consistently regardless of which page a user is on.
| <SubscribeButton | ||
| href='https://www.asyncapi.com/community/meetings' | ||
| className='mt-2 md:ml-2 md:mt-0' | ||
| /> |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Use BASE_URL constant for consistency.
While you've correctly updated the SubscribeButton to use an absolute URL, you should use the BASE_URL constant for consistency with the other links you've updated.
- <SubscribeButton
- href='https://www.asyncapi.com/community/meetings'
- className='mt-2 md:ml-2 md:mt-0'
- />
+ <SubscribeButton
+ href={`${BASE_URL}/community/meetings`}
+ className='mt-2 md:ml-2 md:mt-0'
+ />📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <SubscribeButton | |
| href='https://www.asyncapi.com/community/meetings' | |
| className='mt-2 md:ml-2 md:mt-0' | |
| /> | |
| <SubscribeButton | |
| href={`${BASE_URL}/community/meetings`} | |
| className='mt-2 md:ml-2 md:mt-0' | |
| /> |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
.github/workflows/lighthouse-ci.yml (1)
57-57: Artifact Name Parameter Addition: Verify Consistency and Future Configurability.The addition of the
artifactName: "lighthouse_results"parameter in the Lighthouse Audit step clearly enhances the artifact upload process by explicitly naming the output. Please verify that this naming convention is consistent with the rest of the repository’s CI artifact naming, and consider whether this value should be parameterized or derived from an environment variable for greater flexibility in the future.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/lighthouse-ci.yml(1 hunks)
⏰ Context from checks skipped due to timeout of 180000ms (3)
- GitHub Check: Redirect rules - asyncapi-website
- GitHub Check: Header rules - asyncapi-website
- GitHub Check: Pages changed - asyncapi-website
|
@CodeRabbit-ai can you fix the Lighthouse CI workflow issue? |
|
Tip For best results, initiate chat on the files or code changes. 🧩 Analysis chain@dipishBisht I'll help you fix the Lighthouse CI workflow issue. Let me first examine the current workflow configuration to understand what might be causing the problem. 🏁 Script executed: Length of output: 4760 @dipishBisht Let me examine the Lighthouse configuration file and check recent workflow runs to better understand the issue. 🏁 Script executed: Length of output: 1817 @dipishBisht I can see all the recent Lighthouse CI runs for your PR have failed. Let me check the logs from the most recent run to find out exactly what's causing the issue. 🏁 Script executed: Length of output: 65790 @dipishBisht I've identified the issue with the Lighthouse CI workflow. Based on the logs, the workflow is failing at the artifact upload stage with the error: The problem is in the 🏁 Script executed: Length of output: 69595 @dipishBisht I've identified the issue with the Lighthouse CI workflow. The error occurs during artifact upload: There's an inconsistency in the artifact name in the Lighthouse CI workflow. The workflow specifies 🏁 Script executed: Length of output: 194 @dipishBisht The Lighthouse CI workflow is failing because of an issue with the This typically happens when there's an incompatibility between the artifact name format specified in the workflow and what's expected by the GitHub Actions runner. Let me check the exact files that were changed in your PR to provide a proper fix. 🏁 Script executed: Length of output: 5705 @dipishBisht I've identified the issue with the Lighthouse CI workflow. The problem is with the The error message shows: To fix this, I recommend removing the Here's the specific change needed: - if: steps.should_run.outputs.shouldrun == 'true'
name: Lighthouse Audit
id: lighthouse_audit
uses: treosh/lighthouse-ci-action@03becbfc543944dd6e7534f7ff768abb8a296826 #version 10.1 https://github.com/treosh/lighthouse-ci-action/releases/tag/10.1.0
with:
urls: |
https://deploy-preview-$PR_NUMBER--asyncapi-website.netlify.app/
configPath: ./.github/workflows/lighthouserc.json
uploadArtifacts: true
- artifactName: "lighthouse_results"
temporaryPublicStorage: true
env:
PR_NUMBER: ${{ github.event.pull_request.number}}This should resolve the workflow failure. Would you like me to help you make this change to your PR? 🏁 Script executed: Length of output: 703 @dipishBisht Yes, that's the correct fix! The diff shows we need to remove the Here are the steps to update your PR:
This will resolve the Lighthouse CI workflow issue by letting the action use its default artifact naming convention, which is compatible with GitHub Actions. The error was happening because there might be a format constraint on artifact names in GitHub Actions, and simply removing the parameter allows the system to use its default naming, which is known to work correctly. Would you like me to help with anything else? |
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
markdown/docs/community/onboarding-guide/docs-community.md (1)
23-28:⚠️ Potential issueTable Formatting Issue:
The table is structured correctly; however, the stray text “28” at the end seems out of place and might break the intended markdown rendering. Please verify if this line is accidental and consider removing it.
🧹 Nitpick comments (1)
markdown/docs/community/onboarding-guide/docs-community.md (1)
6-7: Grammar Refinement Suggestion:
The phrase “docs contributors” may be unclear. Consider revising it to “documentation contributors” for improved clarity and grammatical correctness.🧰 Tools
🪛 LanguageTool
[grammar] ~6-~6: Nouns are not usually modified by plural nouns. Is it possible that you meant to use the singular or possessive form here?
Context: ... meetings via Zoom, a regular space for docs contributors to meet and help each othe...(PLURAL_MODIFIER)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (26)
public/img/illustrations/icons/doc-sync.svgis excluded by!**/*.svgpublic/img/illustrations/icons/help.svgis excluded by!**/*.svgpublic/img/illustrations/icons/laptop-cloud.svgis excluded by!**/*.svgpublic/img/illustrations/icons/laptop-globe.svgis excluded by!**/*.svgpublic/img/illustrations/icons/maternity.svgis excluded by!**/*.svgpublic/img/illustrations/icons/mobile-feed.svgis excluded by!**/*.svgpublic/img/illustrations/icons/mouse-globe.svgis excluded by!**/*.svgpublic/img/illustrations/icons/open-source.svgis excluded by!**/*.svgpublic/img/illustrations/icons/plug-cloud.svgis excluded by!**/*.svgpublic/img/illustrations/icons/robotic.svgis excluded by!**/*.svgpublic/img/illustrations/icons/tools.svgis excluded by!**/*.svgpublic/img/illustrations/worker.svgis excluded by!**/*.svgpublic/img/loaders/audio.svgis excluded by!**/*.svgpublic/img/loaders/ball-triangle.svgis excluded by!**/*.svgpublic/img/loaders/bars.svgis excluded by!**/*.svgpublic/img/loaders/circles.svgis excluded by!**/*.svgpublic/img/loaders/grid.svgis excluded by!**/*.svgpublic/img/loaders/hearts.svgis excluded by!**/*.svgpublic/img/loaders/oval.svgis excluded by!**/*.svgpublic/img/loaders/puff.svgis excluded by!**/*.svgpublic/img/loaders/rings.svgis excluded by!**/*.svgpublic/img/loaders/spinning-circles.svgis excluded by!**/*.svgpublic/img/loaders/tail-spin.svgis excluded by!**/*.svgpublic/img/loaders/three-dots.svgis excluded by!**/*.svgpublic/img/logos/asyncapi-horizontal-color.svgis excluded by!**/*.svgpublic/img/posts/bounty-program/photo-from-starship-cockpit.jpegis excluded by!**/*.jpeg
📒 Files selected for processing (3)
config/meetings.json(0 hunks)markdown/docs/community/onboarding-guide/docs-community.md(1 hunks)mlc_config.json(1 hunks)
💤 Files with no reviewable changes (1)
- config/meetings.json
✅ Files skipped from review due to trivial changes (1)
- mlc_config.json
🧰 Additional context used
🪛 LanguageTool
markdown/docs/community/onboarding-guide/docs-community.md
[grammar] ~6-~6: Nouns are not usually modified by plural nouns. Is it possible that you meant to use the singular or possessive form here?
Context: ... meetings via Zoom, a regular space for docs contributors to meet and help each othe...
(PLURAL_MODIFIER)
🔇 Additional comments (5)
markdown/docs/community/onboarding-guide/docs-community.md (5)
1-4: Header Front Matter Formatting:
The front matter is properly delineated with---markers and correctly sets the title and weight metadata.
8-10: Link Verification in List Items:
The links provided (e.g., to the AsyncAPI events page, YouTube channel, and meeting scheduling instructions) appear to be correct and formatted well.
12-14: Community Discussions Section:
The “Docs and education community discussions” section, including its link, is clearly presented and accurate.
15-19: Slack Workspace Links:
The section that invites users to join the AsyncAPI documentation Slack channel includes a valid href and clear instructions. The list item for #13_docs is also well formatted.
20-22: Roadmap Section Consistency:
The “AsyncAPI documentation roadmap 2024” section uses consistent formatting and the provided link to Docs’ Community discussions appears to be correct.
dipishBisht
force-pushed
the
fx/home-community
branch
from
6572a45 to
852789d
Compare
1 participant
Updated both the links to the correct one, now they are redirecting to correct page :)
Summary by CodeRabbit