Skip to content

EDM-259: Unify form labels format#289

Merged
celdrake merged 1 commit into
flightctl:mainfrom
celdrake:EDM-259-unify-form-label-format
May 6, 2025
Merged

EDM-259: Unify form labels format#289
celdrake merged 1 commit into
flightctl:mainfrom
celdrake:EDM-259-unify-form-label-format

Conversation

@celdrake

@celdrake celdrake commented May 6, 2025

Copy link
Copy Markdown
Collaborator

Change the format for name/alias fields so that it's always prefixed by the resource king (eg. Device alias, Fleet name)

Summary by CodeRabbit

  • New Features

    • Added a new translation for "Device alias" in the English locale.
  • Style

    • Updated labels and accessibility attributes to use more specific terms: "Alias" changed to "Device alias" and "Name" changed to "Fleet name" in relevant device and fleet components for improved clarity and accessibility.

@coderabbitai

coderabbitai Bot commented May 6, 2025

Copy link
Copy Markdown

"""

Walkthrough

This change updates user-facing labels and accessibility attributes in English locale files and UI components. The labels "Alias" and "Name" are replaced with the more specific "Device alias" and "Fleet name" in both display text and ARIA attributes. A corresponding translation key is added to the English locale JSON. Additionally, a Cypress test selector was updated to reflect the new "Fleet name" aria-label.

Changes

Files/Paths Change Summary
libs/i18n/locales/en/translation.json Added a new translation key-value pair: "Device alias": "Device alias".
libs/ui-components/src/components/Device/EditDeviceWizard/steps/GeneralInfoStep.tsx Updated aria-label for the device alias field from "Alias" to "Device alias".
libs/ui-components/src/components/Device/EditDeviceWizard/steps/ReviewDeviceStep.tsx Changed device alias label from "Alias" to "Device alias" in the review step.
libs/ui-components/src/components/Fleet/CreateFleet/steps/GeneralInfoStep.tsx Updated aria-label for the fleet name field from "Name" to "Fleet name".
libs/ui-components/src/components/Fleet/CreateFleet/steps/ReviewStep.tsx Changed fleet name label from "Name" to "Fleet name" in the review step.
libs/cypress/pages/CreateFleetWizardPage.ts Updated Cypress selector for fleet name input field to use aria-label "Fleet name" instead of "Name".

Suggested reviewers

  • rawagner
✨ Finishing Touches
  • 📝 Generate Docstrings

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@celdrake celdrake force-pushed the EDM-259-unify-form-label-format branch from d90251b to e39c4a3 Compare May 6, 2025 13:18

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
libs/cypress/pages/CreateFleetWizardPage.ts (1)

22-24: Missing closing bracket in aria-label selector.

This isn't related to the current PR, but there's a syntax error in the selector - the aria-label attribute is missing its closing bracket.

- return cy.get('button[aria-label="Validation"').click();
+ return cy.get('button[aria-label="Validation"]').click();
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d90251b and e39c4a3.

📒 Files selected for processing (6)
  • libs/cypress/pages/CreateFleetWizardPage.ts (1 hunks)
  • libs/i18n/locales/en/translation.json (1 hunks)
  • libs/ui-components/src/components/Device/EditDeviceWizard/steps/GeneralInfoStep.tsx (1 hunks)
  • libs/ui-components/src/components/Device/EditDeviceWizard/steps/ReviewDeviceStep.tsx (1 hunks)
  • libs/ui-components/src/components/Fleet/CreateFleet/steps/GeneralInfoStep.tsx (1 hunks)
  • libs/ui-components/src/components/Fleet/CreateFleet/steps/ReviewStep.tsx (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • libs/ui-components/src/components/Device/EditDeviceWizard/steps/ReviewDeviceStep.tsx
🚧 Files skipped from review as they are similar to previous changes (4)
  • libs/ui-components/src/components/Device/EditDeviceWizard/steps/GeneralInfoStep.tsx
  • libs/ui-components/src/components/Fleet/CreateFleet/steps/GeneralInfoStep.tsx
  • libs/ui-components/src/components/Fleet/CreateFleet/steps/ReviewStep.tsx
  • libs/i18n/locales/en/translation.json
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: integration-tests
  • GitHub Check: Build ocp plugin
  • GitHub Check: Lint
  • GitHub Check: Build
🔇 Additional comments (1)
libs/cypress/pages/CreateFleetWizardPage.ts (1)

18-20: LGTM! This change aligns with the PR objective.

The updated selector correctly uses the more specific "Fleet name" aria-label instead of the generic "Name", which maintains consistency with the updated UI components. This change supports the standardization of form labels to include resource kind prefixes.

@celdrake celdrake merged commit 7bbc025 into flightctl:main May 6, 2025
@celdrake celdrake deleted the EDM-259-unify-form-label-format branch May 6, 2025 14:57
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.

1 participant