Skip to content

Microcopy updates for "project-scoped" items #4448

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

Taj010
Copy link
Contributor

@Taj010 Taj010 commented Jul 3, 2025

For: https://issues.redhat.com/browse/RHOAIENG-27526

Description

Used this doc and make updates accordingly. The main changes includes

  • Adding period at the end of the Model deployment name help text
  • Adding periods at the end of bulleted sentences in popovers for project scope
  • Add a space between 1st and last paragraph and 1st and last bullet in the hardware profile tooltip
  • Change the Global hardware profiles title to Global-scoped hardware profiles

How Has This Been Tested?

Tested the change by navigating to the specific section of the website where the update was made and confirming that the expected change appeared as intended.

Test Impact

Request review criteria:

Self checklist (all need to be checked):

  • The developer has manually tested the changes and verified that the changes work
  • Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
  • The developer has added tests or explained why testing cannot be added (unit or cypress tests for related changes)

If you have UI changes:

  • Included any necessary screenshots or gifs if it was a UI change.
  • Included tags to the UX team if it was a UI/UX change.

After the PR is posted & before it merges:

  • The developer has tested their solution on a cluster by using the image produced by the PR to main

Summary by CodeRabbit

Summary by CodeRabbit

  • Style
    • Improved punctuation consistency by adding periods to helper text and descriptions in various components.
    • Updated label text for clarity in hardware profile selection.
    • Refined list markup for hardware profiles descriptions to enhance readability.
    • Standardized terminology by renaming "global hardware profiles" to "global-scoped hardware profiles" across UI and tests.

Copy link
Contributor

coderabbitai bot commented Jul 3, 2025

Walkthrough

This update adds periods to the end of several helper texts and descriptions across multiple frontend components for punctuation consistency. It also replaces PatternFly list components with nested Content components using HTML list semantics in a hardware profile form section and refines a label text for clarity without altering any logic or behavior. Additionally, related test strings were updated to reflect the label change.

Changes

File(s) Change Summary
frontend/src/components/ProjectScopedPopover.tsx Added periods to the end of two sentences in JSX content for punctuation consistency.
frontend/src/pages/modelServing/screens/projects/InferenceServiceModal/ManageInferenceServiceModal.tsx
frontend/src/pages/modelServing/screens/projects/kServeModal/ManageKServeModal.tsx
Added periods to helper text strings for "Model deployment name" fields.
frontend/src/pages/pipelines/global/modelCustomization/trainingHardwareSection/TrainingHardwareProfileFormSection.tsx Replaced PatternFly List and ListItem components with nested Content components using <ul> and <li> semantics in popover content; updated label text.
frontend/src/concepts/hardwareProfiles/HardwareProfileSelect.tsx
frontend/src/tests/cypress/cypress/tests/mocked/hardwareProfiles/workbenchHardwareProfiles.cy.ts
Updated label text and test strings from "Global hardware profiles" to "Global-scoped hardware profiles".

Suggested labels

lgtm, approved

Suggested reviewers

  • emilys314
  • ashley-o0o

Poem

A dot at the end, how neat and precise,
Punctuation added, the sentences entice.
With lists now nested and labels refined,
Clarity shines, the UI aligned!
🐇✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 55035b4 and 8c7769a.

📒 Files selected for processing (1)
  • frontend/src/pages/pipelines/global/modelCustomization/trainingHardwareSection/TrainingHardwareProfileFormSection.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • frontend/src/pages/pipelines/global/modelCustomization/trainingHardwareSection/TrainingHardwareProfileFormSection.tsx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Lint
  • GitHub Check: Cypress-Setup
✨ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

@openshift-ci openshift-ci bot requested review from manosnoam and ppadti July 3, 2025 13:14
Copy link
Contributor

openshift-ci bot commented Jul 3, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign christianvogt for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link
Contributor

@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: 0

🧹 Nitpick comments (1)
frontend/src/pages/pipelines/global/modelCustomization/trainingHardwareSection/TrainingHardwareProfileFormSection.tsx (1)

82-107: Replace inline spacing with PatternFly utility classes

Inline styles (style={{ marginTop: 10, marginBottom: 8 }} and style={{ marginTop: 8, marginBottom: 10 }}) work but bypass PatternFly’s spacing utilities, making future style maintenance harder and risking inconsistency across themes.

-                      <>
-                        <div style={{ marginTop: 10, marginBottom: 8 }} />
+                      <>
+                        <div className="pf-v5-u-my-sm" />
...
-                        <div style={{ marginTop: 8, marginBottom: 10 }} />
+                        <div className="pf-v5-u-my-sm" />

Using pf-v5-u-my-sm (or another appropriate utility) delegates spacing to the design system and avoids hard-coded pixel values.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 194ee40 and 03fec7b.

📒 Files selected for processing (4)
  • frontend/src/components/ProjectScopedPopover.tsx (1 hunks)
  • frontend/src/pages/modelServing/screens/projects/InferenceServiceModal/ManageInferenceServiceModal.tsx (1 hunks)
  • frontend/src/pages/modelServing/screens/projects/kServeModal/ManageKServeModal.tsx (1 hunks)
  • frontend/src/pages/pipelines/global/modelCustomization/trainingHardwareSection/TrainingHardwareProfileFormSection.tsx (2 hunks)
🔇 Additional comments (3)
frontend/src/pages/modelServing/screens/projects/InferenceServiceModal/ManageInferenceServiceModal.tsx (1)

201-204: Helper-text punctuation change looks good

The period adds the missing punctuation and keeps micro-copy consistent with the rest of the UI.

frontend/src/components/ProjectScopedPopover.tsx (1)

22-26: Micro-copy consistency update approved

Both sentences now end with a period, matching the style guide used elsewhere.

frontend/src/pages/modelServing/screens/projects/kServeModal/ManageKServeModal.tsx (1)

381-387: Minor punctuation fix acknowledged

The trailing period completes the sentence; no functional impact.

Copy link

codecov bot commented Jul 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.52%. Comparing base (8d94660) to head (5f15289).
Report is 8 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #4448      +/-   ##
==========================================
- Coverage   82.61%   82.52%   -0.10%     
==========================================
  Files        1756     1761       +5     
  Lines       36696    36853     +157     
  Branches    10859    10924      +65     
==========================================
+ Hits        30318    30413      +95     
- Misses       6378     6440      +62     
Files with missing lines Coverage Δ
frontend/src/components/ProjectScopedPopover.tsx 100.00% <ø> (ø)
...oncepts/hardwareProfiles/HardwareProfileSelect.tsx 91.74% <ø> (ø)
...erenceServiceModal/ManageInferenceServiceModal.tsx 94.36% <ø> (ø)
...screens/projects/kServeModal/ManageKServeModal.tsx 94.24% <ø> (-0.83%) ⬇️
...wareSection/TrainingHardwareProfileFormSection.tsx 96.66% <100.00%> (ø)

... and 58 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8d94660...5f15289. Read the comment docs.

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

projectScopedHardwareProfiles['1'] &&
projectScopedHardwareProfiles['0'].length > 0 && (
<>
<div style={{ marginTop: 10, marginBottom: 8 }} />
Copy link
Member

Choose a reason for hiding this comment

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

We should avoid using these hardcoded value and the custom styles if possible. When meeting these layout issues, check the PatternFly doc to see if there are existing solutions. Here are some solutions you can consider

  1. Replace <List> and <ListItem> with the <Content> as the example shows, that could generate a proper space between the element above and below
  2. Consider using Stack layout here. This could ensure every element in it has some specific spaces

I'd recommend the first solution because we should try to follow what PatternFly designs as much as possible, that could make sure the layout to follow their design guidelines and standard.

{isProjectScoped &&
projectScopedHardwareProfiles['1'] &&
projectScopedHardwareProfiles['0'].length > 0 && (
<Content>
Copy link
Member

Choose a reason for hiding this comment

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

Use <Content component={ContentVariants.ul}> and <Content component={ContentVariants.li}> to replace ul and li here, avoid using the native HTML element.

Copy link
Member

Choose a reason for hiding this comment

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

This Content will not be needed anymore

Copy link
Contributor

@rsun19 rsun19 left a comment

Choose a reason for hiding this comment

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

isn't this supposed to be Global images instead of Global-scoped images as shown in the doc?

<ProjectScopedGroupLabel isProject>{ScopedType.Project} images</ProjectScopedGroupLabel>

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.

3 participants