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(ui): improve first time alerting experience #14917

Merged
merged 13 commits into from
Sep 4, 2019

Conversation

alexpaxton
Copy link
Contributor

@alexpaxton alexpaxton commented Sep 3, 2019

Closes #14911

The goal is to make it more obvious what to do first in order to get set up with the Monitoring & Alerting feature

  • Added explainer tooltips to all alerting page column headers
  • Swap the placement of Endpoints and Rules columns
    • This should hypothetically indicate that you need to create an endpoint before creating a rule
  • Disable the "Create Rule" button until at least 1 endpoint exists
  • Show a "first time" panel if no checks, rules, or endpoints exist

alerting-page-update-2
Screen Shot 2019-09-03 at 1 52 17 PM

  • CHANGELOG.md updated with a link to the PR (not the Issue)
  • Well-formatted commit messages
  • Rebased/mergeable
  • Tests pass
  • http/swagger.yml updated (if modified Go structs or API)
  • Documentation updated or issue created (provide link to issue/pr)
  • Signed CLA (if not already signed)

@russorat
Copy link
Contributor

russorat commented Sep 3, 2019

Not 100% sold on the column orderings but we will see how it feels. i think it's a net positive for launch.

@alexpaxton alexpaxton requested a review from a team September 3, 2019 23:32
@ghost ghost requested review from chnn and removed request for a team September 3, 2019 23:32
Copy link
Contributor

@chnn chnn left a comment

Choose a reason for hiding this comment

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

I love the little question mark things, I think we should put them all over the UI.

There's some LINEBREAK / <br /> weirdness all over. I suspect that it is hacky around some component API that could be better.

return (
<EmptyState size={ComponentSize.Small} className="alert-column--empty">
<EmptyState.Text
text="A Check is a periodic query that the system performs against your time series data that will generate a status"
text="Looks like you have not created a Check yet LINEBREAK LINEBREAK You will need one to be notified about LINEBREAK any changes in system status"
Copy link
Contributor

Choose a reason for hiding this comment

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

What's up with this LINEBREAK stuff? Could markdown be passed instead? Or the text passed as multiple props?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Glad you asked! The empty state component is overly strict and ends up shooting itself in the foot in the process. I am planning a small change in the next clockface update that should remove all this funk

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah ok, awesome

const tooltipContents = (
<>
A <strong>Check</strong> is a periodic query that the system
<br />
Copy link
Contributor

Choose a reason for hiding this comment

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

Do these <br /> have to be here? Feels like an indication that something else could be fixed

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I manually placed the line breaks in a way that makes it nice to read rather than relying on left/right padding

@alexpaxton alexpaxton merged commit 20f717d into master Sep 4, 2019
@alexpaxton alexpaxton deleted the refactor/improve-first-time-alerting-ux branch September 4, 2019 00:54
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.

Improve guidance for first time experience on Monitoring & Alerting page
3 participants