Skip to content

docs/alerts: explain how alerts work and their issues#43

Merged
bors[bot] merged 2 commits intomasterfrom
docs-alerts
Jul 24, 2018
Merged

docs/alerts: explain how alerts work and their issues#43
bors[bot] merged 2 commits intomasterfrom
docs-alerts

Conversation

@unleashed
Copy link
Copy Markdown
Contributor

No description provided.

@eguzki
Copy link
Copy Markdown
Member

eguzki commented Jul 3, 2018

no link from the main README?

@davidor
Copy link
Copy Markdown
Contributor

davidor commented Jul 3, 2018

I wouldn't link this from the README.

In my opinion, the README should be useful to get started with the project. I would consider including a link to the docs section (if it's not already there) for users who want to learn more advanced topics, like the alerts one.

@eguzki
Copy link
Copy Markdown
Member

eguzki commented Jul 3, 2018

Maybe not from README. My point was to be linked from somewhere. Not requiring people to open the md file manually.

Maybe from DEVELOPMENT.md or some other place.

Comment thread docs/alerts.md
### Alert notification

Alerts are only sent **once** in any given 24 hours period for each application and
utilization percentage regardless of the period for which the utilization
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should also mention metrics.

When an alert has been sent for a given app and utilization %, it won't be sent again when going over limits for a different metric.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@davidor does the change in the commit below make it all read ok to you?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍

@unleashed unleashed force-pushed the docs-alerts branch 3 times, most recently from 90d65d8 to 68f718f Compare July 24, 2018 13:10
While at it also remove the "Platform" part of the product name.
@unleashed
Copy link
Copy Markdown
Contributor Author

Ok, linked to the docs folder from the README.md - @eguzki DTLGTY?

@unleashed
Copy link
Copy Markdown
Contributor Author

bors r=@davidor,@eguzki

bors Bot added a commit that referenced this pull request Jul 24, 2018
43: docs/alerts: explain how alerts work and their issues r=davidor,eguzki a=unleashed



Co-authored-by: Alejandro Martinez Ruiz <amr@redhat.com>
@bors
Copy link
Copy Markdown
Contributor

bors Bot commented Jul 24, 2018

Build succeeded

@bors bors Bot merged commit 82d12f8 into master Jul 24, 2018
@bors bors Bot deleted the docs-alerts branch July 24, 2018 13:26
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.

3 participants