docs(): Added pages for alerting docs, added keyboard shortcuts doc article, #6490

This commit is contained in:
Torkel Ödegaard 2016-11-07 15:18:14 +01:00
parent 3607316920
commit a100836bb4
5 changed files with 95 additions and 35 deletions

View File

@ -1,34 +1,19 @@
<!--- +++ ---> +++
<!--- title = "Alerting" ---> title = "Configuring Alert Rules"
<!--- description = "Alerting" ---> description = "Configuring Alert Rules"
<!--- keywords = ["grafana", "alerting", "guide"] ---> keywords = ["grafana", "alerting", "guide", "rules"]
<!--- type = "docs" ---> type = "docs"
<!--- [menu.docs] ---> [menu.docs]
<!--- name = "Alerting" ---> name = "Alert Rules"
<!--- identifier = "alerting" ---> parent = "alerting"
<!--- parent = "features" ---> weight = 1
<!--- weight = 6 ---> +++
<!--- +++ --->
<!--- ---> # Alert Rules
<!--- # Alerting --->
<!--- ---> > Alerting is only available in Grafana v4.0 and above.
<!--- > Alerting is still in very early development. Please be aware. --->
<!--- --->
<!--- The roadmap for alerting in Grafana have been changing rapidly during last 2-3 months. So make sure you follow the disucssion in the [alerting issue](https://github.com/grafana/grafana/issues/2209). ---> hk
<!--- --->
<!--- ## Introduction --->
<!--- --->
<!--- > Alerting is turned off by default and have to be enabled in the config file. --->
<!--- --->
<!--- Grafana lets you define alert rules based on metrics queries on dashboards. Every alert is connected to a panel and when ever the query for the panel is updated the alerting rule is also updated. --->
<!--- So far only the graph panel supports alerting. To enable alerting for a panel go to the alerting tab and press 'Create alert' button. --->
<!--- --->
<!--- ## Alert status page --->
<!--- --->
<!--- You can overview all your current alerts on the alert stats page at /alerting --->
<!--- --->
<!--- ## Alert notifications --->
<!--- --->
<!--- When an alert is triggered it goes to the notification handler who takes care of sending emails or push data as webhooks. --->
<!--- The alert notifications can be configured on /alerting/notifications --->
<!--- --->

View File

@ -0,0 +1,9 @@
+++
title = "Alerting"
type = "docs"
[menu.docs]
identifier = "alerting"
parent = "features"
weight = 6
+++

View File

@ -0,0 +1,13 @@
+++
title = "Alerting Notifications"
description = "Alerting Notifications Guide"
keywords = ["grafana", "alerting", "guide", "notifications"]
type = "docs"
[menu.docs]
name = "Notifications"
parent = "alerting"
weight = 2
+++
# Alerting Notifications

View File

@ -0,0 +1,53 @@
+++
title = "Keyboard Shortcuts"
type = "docs"
[menu.docs]
parent = "features"
weight = 7
+++
# Keyboard shortcuts
{{< docs-imagebox img="/img/docs/v4/shortcuts.png" max-width="14rem" >}}
Grafana v4 introduces a number of really powerful keyboard shortcuts. You can now focus a panel
by hovering over it with your mouse. With a panel focused you can simple hit `e` to toggle panel
edit mode, or `v` to toggle fullscreen mode. `p` `r` removes the panel. `p` `s` opens share
modal.
Hit `?` on your keyboard to open the shortcuts help modal.
### Global
- `g` `h` Go to Home Dashboard
- `g` `p` Go to Profile
- `s` `o` Open search
- `s` `s` Open search with starred filter
- `s` `t` Open search in tags view
- `esc` Exit edit/setting views
### Dashboard
- `mod+s` Save dashboard
- `mod+h` Hide row controls
- `d` `r` Refresh all panels
- `d` `s` Dashboard settings
- `d` `v` Toggle in-active / view mode
- `d` `k` Toggle kiosk mode (hides top nav)
- `mod+o` Toggle shared graph crosshair
### Focused Panel
- `e` Toggle panel edit view
- `v` Toggle panel fullscreen view
- `p` `s` Open Panel Share Modal
- `p` `r` Remove Panel
### Focused Row
- `r` `c` Collapse Row
- `r` `r` Remove Row
### Time Range
- `t` `z` Zoom out time range
- `t` Move time range back
- `t` Move time range forward

View File

@ -20,7 +20,7 @@
<div class="modal-content help-modal"> <div class="modal-content help-modal">
<p class="small" style="position: absolute; top: 48px;, right: 10px"> <p class="small" style="position: absolute; top: 48px; right: 10px">
<span class="shortcut-table-key">mod</span> = <span class="shortcut-table-key">mod</span> =
<span class="muted">CTRL on windows, CMD key on Mac</span> <span class="muted">CTRL on windows, CMD key on Mac</span>
</p> </p>