Add description to dimensions and segments #1496
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Screenshots
Segment index page before
Segment index page after
Segment index page after with segment description tooltip hovered
Segment index page after with data source description tooltip hovered
Dimension index page before
Dimension index page after
Dimension index page after with segment description tooltip hovered
Dimension index page after with data source description tooltip hovered
Data Source Index page before
Data Source Index page after