Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: fixed Newsletter page labels #3238

Closed
wants to merge 2 commits into from
Closed

fix: fixed Newsletter page labels #3238

wants to merge 2 commits into from

Conversation

hkv24
Copy link
Contributor

@hkv24 hkv24 commented Sep 15, 2024

Description
Updated the placeholder values of the two input fields and the button on '/newsletter' route.

Screenshot
Screenshot 2024-09-17 at 12 01 59 AM

Fixes #3236

Summary by CodeRabbit

  • New Features
    • Updated placeholder text for the name and email input fields to 'Your Name' and 'Your Email', respectively.
    • Changed the button text to 'Subscribe' for improved clarity in the newsletter subscription form.

Copy link

netlify bot commented Sep 15, 2024

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 534f4fa
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/67060a31019db70008aa7655
😎 Deploy Preview https://deploy-preview-3238--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 site configuration.

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Sep 15, 2024

⚡️ Lighthouse report for the changes in this PR:

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

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

@sambhavgupta0705
Copy link
Member

/update

Copy link

coderabbitai bot commented Oct 9, 2024

Walkthrough

The changes made in the NewsletterSubscribe component involve updating the user interface by replacing translation keys with static text for input field placeholders and button labels. Specifically, the name and email input fields now display "Your Name" and "Your Email," respectively, while the subscribe button is labeled "Subscribe." These modifications aim to correct the button labels as per the requirements outlined in the linked issue.

Changes

File Change Summary
components/NewsletterSubscribe.tsx Updated placeholders for name and email inputs to static text; changed button text to 'Subscribe'.

Assessment against linked issues

Objective Addressed Explanation
Correct button labels and input field placeholders (3236)

🐰 In the newsletter, we now say,
"Your Name" and "Your Email" all day!
The button now shouts, "Subscribe!" with glee,
Hop on board, join the fun with me!
No more confusion, just clear delight,
A joyful change that feels just right! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
components/NewsletterSubscribe.tsx (1)

137-150: Document the decision to use static strings instead of translation keys

While the changes successfully fix the labels on the Newsletter page as per the PR objectives, they introduce a potential inconsistency in the internationalization approach of the component.

Consider the following points:

  1. Document the reasoning behind using static strings for these specific elements while keeping translations for others.
  2. Ensure that this approach aligns with the long-term internationalization strategy of the project.
  3. If the intention is to remove translations for the entire component, consider updating the remaining translated elements for consistency.

This documentation will help maintain clarity about the internationalization approach and prevent confusion in future development.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 662ec26 and 534f4fa.

⛔ Files ignored due to path filters (1)
  • .github/workflows/scripts/mailchimp/package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (1)
  • components/NewsletterSubscribe.tsx (1 hunks)
🧰 Additional context used
🔇 Additional comments (2)
components/NewsletterSubscribe.tsx (2)

144-144: ⚠️ Potential issue

Remove unnecessary translation function for static text

Similar to the previous comment, the t() function is unnecessary for the static email placeholder text.

Apply the same change as suggested for the name input placeholder:

-placeholder={t('Your Email')}
+placeholder={'Your Email'}

150-150: ⚠️ Potential issue

Remove unnecessary translation function for static text

As with the previous two comments, the t() function is unnecessary for the static button text.

Apply the same change as suggested for the input placeholders:

-text={t('Subscribe')}
+text={'Subscribe'}

@@ -134,20 +134,20 @@ export default function NewsletterSubscribe({
<InputBox
inputType={InputTypes.TEXT}
inputName='name'
placeholder={t('newsletterCTA.nameInput')}
placeholder={t('Your Name')}
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Remove unnecessary translation function for static text

The placeholder text has been changed from a translation key to a static string, which aligns with the PR objective. However, wrapping a static string with t() is unnecessary and defeats the purpose of internationalization.

Consider removing the t() function:

-placeholder={t('Your Name')}
+placeholder={'Your Name'}

This change will maintain the intended functionality while simplifying the code.

📝 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.

Suggested change
placeholder={t('Your Name')}
placeholder={'Your Name'}

@sambhavgupta0705
Copy link
Member

@coderabbitai please create a new issue for this

@sambhavgupta0705
Copy link
Member

closing this as no response from contributor

Copy link

coderabbitai bot commented Nov 1, 2024

Tip

For best results, initiate chat on the files or code changes.

@sambhavgupta0705, I've created a new issue to track the performance improvements based on the Lighthouse report: #3356

🔗 Analysis chain

@sambhavgupta0705, I will create a new issue for this.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
gh issue create --title "Improve Performance Based on Lighthouse Report" \
--body "As observed in the [Lighthouse report](https://storage.googleapis.com/lighthouse-infrastructure.appspot.com/reports/1728449109632-14921.report.html) from PR #3238 (https://github.com/asyncapi/website/pull/3238), the Performance score is low (42). This issue is to track efforts to improve the website's performance. Original request by @sambhavgupta0705." \
--assignee sambhavgupta0705

Length of output: 517

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.

[BUG] Newsletter page does not have correct button labels
3 participants