Skip to content

upcoming: [M3-7357] - Add AGLB Helper Text and Copy#9908

Merged
bnussman-akamai merged 12 commits intolinode:developfrom
bnussman-akamai:M3-7357-add-aglb-copy
Nov 28, 2023
Merged

upcoming: [M3-7357] - Add AGLB Helper Text and Copy#9908
bnussman-akamai merged 12 commits intolinode:developfrom
bnussman-akamai:M3-7357-add-aglb-copy

Conversation

@bnussman-akamai
Copy link
Member

@bnussman-akamai bnussman-akamai commented Nov 15, 2023

Description 📝

Adds copy and helper text for the AGLB project 📝

How to test 🧪

Prerequisites

  • Turn on the MSW or test with the dev-test-aglb account in dev

Verification steps

  • Check over all copy added throughout AGLB 👀
    • Check spelling, capitalization, styling 🎨
    • Things might not be 100% perfect or final, I'm doing my best to work with what we've got.

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 ACLB Relating to the Akamai Cloud Load Balancer label Nov 15, 2023
@bnussman-akamai bnussman-akamai self-assigned this Nov 15, 2023
@bnussman-akamai bnussman-akamai marked this pull request as ready for review November 21, 2023 20:47
@bnussman-akamai bnussman-akamai requested a review from a team as a code owner November 21, 2023 20:47
@bnussman-akamai bnussman-akamai requested review from cliu-akamai and cpathipa and removed request for a team November 21, 2023 20:47
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.

Nice job tracking all these copy edits down. 🔍

I've left a handful of nitpicks and a couple questions. The most significant of which was: in several instances (mostly Routes/Rules and Service Target drawers), I see copy updates that aren't reflected in the mocks. Is there another source of truth?

<Autocomplete
textFieldProps={{
labelTooltipText: 'TODO: AGLB',
labelTooltipText: CONFIGURATION_COPY.Protocol,
Copy link
Contributor

Choose a reason for hiding this comment

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

This tooltip needs an interactive prop in order to allow the user to click on the link. With the current behavior, the tooltip popover disappears before a user can click it.

Screen.Recording.2023-11-27.at.12.30.56.PM.mov

Copy link
Member Author

Choose a reason for hiding this comment

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

Unfortunately, our TextField doesn't support that... Might have to do this as a follow up

Copy link
Contributor

Choose a reason for hiding this comment

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

Optional nit: it's a little weird for UX for some of the drawer content to wrap differently once the session stickiness is toggled. I didn't look into the styling, but if it's an easy fix then it would be nice to change.

Screen.Recording.2023-11-27.at.12.56.48.PM.mov

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.

🧼 Thanks for the updates! Everything addressed looks good now.

As far as the textfield tooltip: yeah, I figured that was going to be an issue. A follow up PR sounds good to me; we'd have run into that issue eventually anyway.

In my second pass through, I checked all screen sizes. I'm not going to hold up approving this PR for this, but there were two small edge case issues I noticed in the Add Rule drawer on small mobile screens:

  1. The match value text field is prone to overflowing the container
  2. The Cookie type tooltip gets cut off in its last sentence
Screenshots

Screenshot 2023-11-27 at 2 08 15 PM

Screenshot 2023-11-27 at 2 08 01 PM

Screenshot 2023-11-27 at 2 08 08 PM

@mjac0bs mjac0bs added the Add'tl Approval Needed Waiting on another approval! label Nov 27, 2023
@bnussman-akamai
Copy link
Member Author

Don't worry, I will definitely take a second PR to clean up and refine things that need to be improved/changed with Sandra's review

Copy link
Contributor

@cpathipa cpathipa left a comment

Choose a reason for hiding this comment

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

Over all looks great! Verified the copy and no spelling errors found.

@@ -0,0 +1,42 @@
import type { Certificate } from '@linode/api-v4';

Copy link
Contributor

Choose a reason for hiding this comment

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

I like the idea of keeping tooltips copy in constants. No spelling errors found in this file.

@@ -0,0 +1,41 @@
import React from 'react';

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks good! No spelling errors found here.
@bnussman-akamai Any thoughts in keeping this files as contants.ts and having this getConfigurationPayloadFromConfiguration function and Protocol in a util file?

'For TCP load balancers, a rule consists of service targets and the percentage of incoming requests that should be directed to each target. Add as many service targets as required, but the percentages for all targets must total 100%.',
},
MatchValue: {
header: 'The format for http header is: X-name=value.',
Copy link
Contributor

Choose a reason for hiding this comment

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

The format is X-name=value or X-name:value ?

Copy link
Member Author

Choose a reason for hiding this comment

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

X-name=value should be correct

@@ -0,0 +1,41 @@
export const ROUTE_COPY = {
Copy link
Contributor

Choose a reason for hiding this comment

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

No spelling errors in this file.

@@ -0,0 +1,144 @@
import React from 'react';

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks good. No spelling errors found in this file.

@bnussman-akamai bnussman-akamai added Approved Multiple approvals and ready to merge! and removed Add'tl Approval Needed Waiting on another approval! labels Nov 28, 2023
@bnussman-akamai bnussman-akamai merged commit fec8b2d into linode:develop Nov 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ACLB Relating to the Akamai Cloud Load Balancer Approved Multiple approvals and ready to merge! Ready for Review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants