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

Add description to dimensions and segments #1496

Merged
merged 8 commits into from Jul 26, 2023

Conversation

mknowlton89
Copy link
Collaborator

@mknowlton89 mknowlton89 commented Jul 21, 2023

Features and Changes

This PR adds the ability for a user to add a description to a dimension or segment, so all company stakeholders can quickly get information about exactly what the segment and dimension is, if there is not enough context in the name alone.

These descriptions are now displayed on the dimension and segment index pages as tooltips next to the name field.

Originally, I added the description as a new column on the table on the segment & dimension index pages, but, that table is already nearly overflowing with content. As such, I tried a new pattern where the description is accessible on hover via a Tooltip next to the asset's name.

Additionally, I applied this pattern to the data source's description field as well. With the current treatment, we truncate the description field if it exceeds the small amount of real estate allocated for it, requiring the user to go into the asset's page to get the full context. Now, they can simple hover and see the full description, even if it's on the long side.

This pattern has also been applied to the data source index page as well.

Testing

  • Create a new dimension/segment and include a description and ensure that is persisted within the database and is displayed on the index page, and then within the form when editing.
  • Create a new dimension/segment and DON'T include a description and ensure no errors are thrown.
  • Go to an existing dimension/segment that was created before this PR, and ensure you can add a description and that it's persisted on the database.
  • Go to an existing dimension/segment and edit it, but don't add a description and ensure no errors are thrown.
  • Ensure the description is displayed on it's respective index page via a tooltip.
  • Ensure that if a dimension/segment doesn't have a description, no tooltip is shown on the respective index page.

Screenshots

Segment index page before
Screen Shot 2023-07-24 at 7 07 20 AM

Segment index page after
Screen Shot 2023-07-24 at 7 05 17 AM

Segment index page after with segment description tooltip hovered
Screen Shot 2023-07-24 at 7 05 24 AM

Segment index page after with data source description tooltip hovered
Screen Shot 2023-07-24 at 7 05 31 AM

Dimension index page before
Screen Shot 2023-07-24 at 7 07 27 AM

Dimension index page after
Screen Shot 2023-07-24 at 7 04 54 AM

Dimension index page after with segment description tooltip hovered
Screen Shot 2023-07-24 at 7 05 09 AM

Dimension index page after with data source description tooltip hovered
Screen Shot 2023-07-24 at 7 05 02 AM

Data Source Index page before
Screen Shot 2023-07-24 at 7 27 19 AM

Data Source Index page after
Screen Shot 2023-07-24 at 7 27 00 AM

@github-actions
Copy link

github-actions bot commented Jul 21, 2023

Your preview environment pr-1496-bttf has been deployed.

Preview environment endpoints are available at:

…iptions on the segment and dimension index pages. They now use tooltips so the user can easily see, on hover, the description of the underlying asset easily.
@mknowlton89 mknowlton89 self-assigned this Jul 24, 2023
@mknowlton89 mknowlton89 linked an issue Jul 24, 2023 that may be closed by this pull request
@mknowlton89 mknowlton89 requested review from jdorn, bttf, bryce-fitzsimons, a team and Auz July 24, 2023 11:22
@mknowlton89 mknowlton89 marked this pull request as ready for review July 24, 2023 11:23
@mknowlton89 mknowlton89 requested a review from jdorn July 26, 2023 13:13
@mknowlton89 mknowlton89 merged commit 88ea09c into main Jul 26, 2023
3 checks passed
@mknowlton89 mknowlton89 deleted the mk/add-dimension-segment-description branch July 26, 2023 14:58
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.

[Feature] Add description to Dimensions and Segments
2 participants