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

refactor: [M3-8775] - Make the Support Ticket UI look slightly less broken #11144

Conversation

bnussman-akamai
Copy link
Member

@bnussman-akamai bnussman-akamai commented Oct 22, 2024

Description 📝

  • Slightly improves styles throughout the support ticket UI 🎟️

Preview 📷

Before After
Screenshot 2024-10-22 at 6 43 00 PM Screenshot 2024-10-22 at 6 42 54 PM
Screenshot 2024-10-22 at 6 43 16 PM Screenshot 2024-10-22 at 6 43 11 PM
Screenshot 2024-10-22 at 6 44 13 PM Screenshot 2024-10-22 at 6 44 07 PM
Screenshot 2024-10-22 at 6 44 50 PM Screenshot 2024-10-22 at 6 44 42 PM

How to test 🧪

  • Test general support ticket UI and functionality 🧪
  • Verify the UI looks better than the current UI 🎨
  • Test in light 🌞 and dark 🌚 mode

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

@bnussman-akamai bnussman-akamai added the UX/UI Changes for UI/UX to review label Oct 22, 2024
@bnussman-akamai bnussman-akamai self-assigned this Oct 22, 2024
@bnussman-akamai bnussman-akamai requested a review from a team as a code owner October 22, 2024 22:49
@bnussman-akamai bnussman-akamai requested review from carrillo-erik and cpathipa and removed request for a team October 22, 2024 22:49
@bnussman-akamai bnussman-akamai changed the title refactor: Make the Support Ticket UI slightly less ugly refactor: Make the Support Ticket UI slightly less broken looking Oct 22, 2024
Copy link

github-actions bot commented Oct 23, 2024

Coverage Report:
Base Coverage: 86.99%
Current Coverage: 86.99%

Copy link
Contributor

@mjac0bs mjac0bs left a comment

Choose a reason for hiding this comment

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

Improvements look great - I completely missed the Formatting Tips dropdown in #10979, so thank you for the follow up. Can we also track this in an internal ticket by copying the PR description over and getting this PR title updated?

Left a few comments after looking through this in light and dark mode. The one real minor regression is with the top padding in Preview mode.

<Typography>
You can use Markdown to format your{' '}
{props.isReply ? 'reply' : 'question'}. For more examples see this{' '}
<Link external to="https://commonmark.org/help/">
Markdown cheatsheet
</Link>
</Typography>
<Typography className={classes.header}>
<strong>Examples</strong>
<Typography fontFamily={(theme) => theme.font.bold} variant="h3">
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we want Formatting Tips and this Examples header to both be h3s, semantically.

Screenshot 2024-10-23 at 9 07 46 AM

Copy link
Member Author

@bnussman-akamai bnussman-akamai Oct 23, 2024

Choose a reason for hiding this comment

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

I would have used h4 if it was properly implemented 😭

Any recommendations on what to do here?

We could implement h4 in the theme relatively easily. I will just use bold text for now in abb4f5d

Copy link
Contributor

Choose a reason for hiding this comment

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

h4 is ginormous, ha. I see now that we've only got h1-h3 and subtitle1 in our theme. It doesn't look like subtitle1 is what we want here, either. My preference would be to implement h4 in theme, since that's really the way to avoid running into this again in the future. Seems like it would be a small lift?

Copy link
Contributor

Choose a reason for hiding this comment

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

Just saw the latest edit to your comment which I think you updated at almost the same time I posted mine. Agreed that bolded looks fine here.

Screenshot 2024-10-23 at 10 33 01 AM

Copy link
Contributor

Choose a reason for hiding this comment

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

The changes look good and it improves the previous iteration. In the future, if you run into something similar and want to explore another workaround consider the following.

The <Typography> component can actually take a component prop and styling can be accomplished with the variant and sx props like this:

<Typography
  component="span"
  sx={(theme) => padding: theme.spacing(1)} 
  variant="body1"
>

@bnussman-akamai bnussman-akamai changed the title refactor: Make the Support Ticket UI slightly less broken looking refactor: [M3-8775] - Make the Support Ticket UI slightly less broken looking Oct 23, 2024
@bnussman-akamai bnussman-akamai changed the title refactor: [M3-8775] - Make the Support Ticket UI slightly less broken looking refactor: [M3-8775] - Make the Support Ticket UI look slightly less broken Oct 23, 2024
Copy link
Contributor

@mjac0bs mjac0bs left a comment

Choose a reason for hiding this comment

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

🎨 🫧 Looking slightly less broken!

@mjac0bs mjac0bs added the Add'tl Approval Needed Waiting on another approval! label Oct 23, 2024
@harsh-akamai harsh-akamai self-requested a review October 24, 2024 11:09
@harsh-akamai
Copy link
Contributor

Changes look good. Just found one small regression with the top padding for the Formatting Tips Accordion.

The padding is removed when the Accordion is collapsed but it's added back when the Accordion is expanded.

Accordion collpased Accordion expanded
image image

@bnussman-akamai bnussman-akamai added Approved Multiple approvals and ready to merge! and removed Add'tl Approval Needed Waiting on another approval! labels Oct 24, 2024
@bnussman-akamai bnussman-akamai merged commit 427b55c into linode:develop Oct 24, 2024
23 checks passed
Copy link

cypress bot commented Oct 24, 2024

Cloud Manager E2E    Run #6729

Run Properties:  status check failed Failed #6729  •  git commit 427b55c44e: refactor: [M3-8775] - Make the Support Ticket UI look slightly less broken (#111...
Project Cloud Manager E2E
Branch Review develop
Run status status check failed Failed #6729
Run duration 28m 24s
Commit git commit 427b55c44e: refactor: [M3-8775] - Make the Support Ticket UI look slightly less broken (#111...
Committer Banks Nussman
View all properties for this run ↗︎

Test results
Tests that failed  Failures 1
Tests that were flaky  Flaky 1
Tests that did not run due to a developer annotating a test with .skip  Pending 2
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 444
View all changes introduced in this branch ↗︎

Tests for review

Failed  cypress/e2e/core/linodes/clone-linode.spec.ts • 1 failed test

View Output Video

Test Artifacts
clone linode > can clone a Linode from Linode details page Screenshots Video
Flakiness  cypress/e2e/core/account/service-transfer.spec.ts • 1 flaky test

View Output Video

Test Artifacts
Account service transfers > can initiate and cancel a service transfer Screenshots Video

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! Ready for Review UX/UI Changes for UI/UX to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants