Skip to content

upcoming: [M3-7932] - Placement Groups copy updates - #10399

Merged
carrillo-erik merged 3 commits into
linode:developfrom
carrillo-erik:upcoming/M3-7932
Apr 25, 2024
Merged

carrillo-erik merged 3 commits into
linode:developfrom
carrillo-erik:upcoming/M3-7932

Conversation

@carrillo-erik

@carrillo-erik carrillo-erik commented Apr 23, 2024 •

Copy link
Copy Markdown
Contributor

Description 📝

Updates to the text copy as it pertains to the Placement Groups project.
⚠️ This is NOT the final copy ⚠️

Changes 🔄

  • No code changes, just text copy updates. Please, refer to the Internal Ticket and the Mocks for information on where the changes are made.

Target release date 🗓️

04/29/2024

How to test 🧪

Prerequisites

(How to setup test environment)

  • Using the Cloud Manager developer tools:
    • Switch to the dev API
    • Turn the "Placement Group" feature flag on
    • Turn MSW off

Verification steps

(How to verify changes)

  • Using the information on the Internal Ticket and the Mocks do a quick inspections that the text copy changes satisfy the requirements.

As an Author I have considered 🤔

  • 👀 Doing a self review
  • ❔ Our contribution guidelines
  • 🤏 Splitting feature into small PRs
  • ➕ Adding a changeset
  • 🧪 Providing/Improving test coverage
  • 🔐 Removing all sensitive information from the code and PR description
  • 🚩 Using a feature flag to protect the release
  • 👣 Providing comprehensive reproduction steps
  • 📑 Providing or updating our documentation
  • 🕛 Scheduling a pair reviewing session
  • 📱 Providing mobile support
  • ♿ Providing accessibility support

@carrillo-erik carrillo-erik self-assigned this Apr 23, 2024
@carrillo-erik
carrillo-erik requested a review from a team as a code owner April 23, 2024 16:11
@carrillo-erik
carrillo-erik requested review from abailly-akamai and mjac0bs and removed request for a team April 23, 2024 16:11

@mjac0bs mjac0bs left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

There are several failing unit tests and a Cypress test that need updates here due to these copy changes. Should be quick updates!

Screenshot 2024-04-23 at 2 38 56 PM
Screenshot 2024-04-23 at 2 38 40 PM
Screenshot 2024-04-23 at 2 38 30 PM
Screenshot 2024-04-23 at 2 38 17 PM
Screenshot 2024-04-23 at 2 38 10 PM

Comment thread packages/manager/src/features/PlacementGroups/PlacementGroupsCreateDrawer.tsx Outdated
@carrillo-erik
carrillo-erik requested a review from a team as a code owner April 24, 2024 16:40
@carrillo-erik
carrillo-erik requested review from cliu-akamai and removed request for a team April 24, 2024 16:40
@carrillo-erik

Copy link
Copy Markdown
Contributor Author

There are several failing unit tests and a Cypress test that need updates here due to these copy changes. Should be quick updates!

@mjac0bs The test updates have been pushed. I've tested both unit and e2e tests locally and everything should be fixed.

@github-actions

Copy link
Copy Markdown

Coverage Report: ✅
Base Coverage: 81.86%
Current Coverage: 81.86%

@abailly-akamai abailly-akamai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copy updates look good

@carrillo-erik did you get to also confirm warning banners copy?

@mjac0bs mjac0bs left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks good from what I can tell based on the ticket and the mocks. I didn't see the warning banner permission change and I'm not certain whether there was a specific Assign Drawer change intended. Screenshots always help in the PR description when making copy updates.

The CI failures are unrelated, though linode-config was fixed last week in develop. Joe is aware of the obj test failure.

minWidth={225}
/>{' '}
support Placement Groups.
support placement groups.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I did a case sensitive search for "Placement Group[s]" and found more instances of it capitalized. I understand current copy isn't finalized, but below are a few instances (there are more) where capitalization should be revisited by UX and copywriting for consistency in the future: (cc @abailly-akamai, so you can keep an eye out before release)

  • "Only regions supporting Placement Groups are listed." in PlacementGroupsCreateDrawer.tsx
  • "Loading your Placement Groups..." and "No available Placement Groups" in PlacementGroupsSelect.tsx
  • "Placement Groups are not available in this region" and "There are no Placement Groups in this region" in ConfigureForm.tsx
  • "There are no Placement Groups in this region." and "This region has reached its Placement Group capacity" in PlacementGroupsDetailPanel.tsx

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This capitalization business has been a new thing for this feature. I understand the intent but it seems to create a bit of distortion for people, and frankly although the capitalization rules have been explained to me (Product VS Instance) it does not fully make sense to me.

As to the points above, i was hoping to see more constants being made as a result of this PR since we have strings duplicates, hopefully that can be done in the final copy PR

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@mjac0bs There are instances where the copy refers to Placement Group(s) as a product name, in which case both words are capitalized. In other cases, placement group(s) is used as a noun and we don't require capitalization. As the copy changes, so does the way the term is used. Thanks for the list of places to keep an eye on.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

frankly although the capitalization rules have been explained to me (Product VS Instance) it does not fully make sense to me.

I think I'm with ya. 😬 As long as it's clear to users...

@mjac0bs mjac0bs added the Approved Multiple approvals and ready to merge! label Apr 24, 2024
@carrillo-erik

Copy link
Copy Markdown
Contributor Author

Copy updates look good

@carrillo-erik did you get to also confirm warning banners copy?

@abailly-akamai I did go through the banners and notices copy.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Approved Multiple approvals and ready to merge! Placement Groups

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants