From b21a1301187e0f779bdb1d04e692e2b8dadedc0e Mon Sep 17 00:00:00 2001 From: Linus Groh Date: Mon, 7 Oct 2019 13:56:00 +0100 Subject: [PATCH] Docs: Update keyboard shortcuts formatting (#19637) * Docs: Update keyboard shortcuts formatting in docs * Docs: Update keystroke separators * Docs: Remove spaces in keyboard shortcuts --- docs/README.md | 2 +- docs/sources/features/explore/index.md | 2 +- docs/sources/features/panels/graph.md | 2 +- docs/sources/features/shortcuts.md | 2 +- docs/sources/guides/whats-new-in-v4-1.md | 2 +- docs/sources/guides/whats-new-in-v4-6.md | 2 +- docs/sources/reference/annotations.md | 4 ++-- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/README.md b/docs/README.md index d37c79833e6..929666d8a78 100644 --- a/docs/README.md +++ b/docs/README.md @@ -77,7 +77,7 @@ make docs-build This will rebuild the docs Docker image. -To be able to use your image(s) you have to quit (CTRL-C) the `make watch` command (that you run in the same directory as this README). Then simply rerun `make watch`, it will restart the docs server but now with access to your image(s). +To be able to use your image(s) you have to quit (Ctrl+C) the `make watch` command (that you run in the same directory as this README). Then simply rerun `make watch`, it will restart the docs server but now with access to your image(s). ### Editing content diff --git a/docs/sources/features/explore/index.md b/docs/sources/features/explore/index.md index 64d2a294864..39a6c24f5c9 100644 --- a/docs/sources/features/explore/index.md +++ b/docs/sources/features/explore/index.md @@ -63,7 +63,7 @@ On the left-hand side of the query field is a `Metrics` button, clicking on this The Query field supports autocomplete for metric names, function and works mostly the same way as the standard Prometheus query editor. Press the enter key to execute a query. -The autocomplete menu can be trigger by pressing Ctrl + Space. The Autocomplete menu contains a new History section with a list of recently executed queries. +The autocomplete menu can be trigger by pressing Ctrl+Space. The Autocomplete menu contains a new History section with a list of recently executed queries. Suggestions can appear under the query field - click on them to update your query with the suggested change. diff --git a/docs/sources/features/panels/graph.md b/docs/sources/features/panels/graph.md index 6625e587a0a..57d81218744 100644 --- a/docs/sources/features/panels/graph.md +++ b/docs/sources/features/panels/graph.md @@ -18,7 +18,7 @@ The main panel in Grafana is simply named Graph. It provides a very rich set of 1. Clicking the title for a panel exposes a menu. The `edit` option opens additional configuration options for the panel. 2. Click to open color and axis selection. -3. Click to only show this series. Shift/Ctrl + click to hide series. +3. Click to only show this series. Shift/Ctrl+Click to hide series. ## General diff --git a/docs/sources/features/shortcuts.md b/docs/sources/features/shortcuts.md index a4bd55eebeb..5a758e67e79 100644 --- a/docs/sources/features/shortcuts.md +++ b/docs/sources/features/shortcuts.md @@ -50,4 +50,4 @@ Hit `?` on your keyboard to open the shortcuts help modal. - `t` Move time range back - `t` Move time range forward -mod = CTRL on Windows or Linux and CMD key on macOS +mod = Ctrl on Windows or Linux and Cmd key on macOS diff --git a/docs/sources/guides/whats-new-in-v4-1.md b/docs/sources/guides/whats-new-in-v4-1.md index 664093c939d..019ee5ca792 100644 --- a/docs/sources/guides/whats-new-in-v4-1.md +++ b/docs/sources/guides/whats-new-in-v4-1.md @@ -25,7 +25,7 @@ weight = 3 {{< imgbox max-width="60%" img="/img/docs/v41/shared_tooltip.gif" caption="Shared tooltip" >}} Showing the tooltip on all panels at the same time has been a long standing request in Grafana and we are really happy to finally be able to release it. -You can enable/disable the shared tooltip from the dashboard settings menu or cycle between default, shared tooltip and shared crosshair by pressing `CTRL + O` or `CMD + O`. +You can enable/disable the shared tooltip from the dashboard settings menu or cycle between default, shared tooltip and shared crosshair by pressing Ctrl/Cmd+O.
diff --git a/docs/sources/guides/whats-new-in-v4-6.md b/docs/sources/guides/whats-new-in-v4-6.md index c95553121ac..b985db01f04 100644 --- a/docs/sources/guides/whats-new-in-v4-6.md +++ b/docs/sources/guides/whats-new-in-v4-6.md @@ -18,7 +18,7 @@ Grafana v4.6 brings many enhancements to Annotations, Cloudwatch and Prometheus. {{< docs-imagebox img="/img/docs/v46/add_annotation_region.png" max-width= "800px" >}} -You can now add annotation events and regions right from the graph panel! Just hold CTRL/CMD + click or drag region to open the **Add Annotation** view. The +You can now add annotation events and regions right from the graph panel! Just hold Ctrl/Cmd+Click or drag region to open the **Add Annotation** view. The [Annotations]({{< relref "reference/annotations.md" >}}) documentation is updated to include details on this new exciting feature. ### Cloudwatch diff --git a/docs/sources/reference/annotations.md b/docs/sources/reference/annotations.md index d689b2943e0..3f56ba9856a 100644 --- a/docs/sources/reference/annotations.md +++ b/docs/sources/reference/annotations.md @@ -21,14 +21,14 @@ Grafana v4.6+ comes with a native annotation store and the ability to add annota ## Adding annotations -By holding down **CTRL** or **CMD** + Click. Add tags to the annotation will make it searchable from other dashboards. +By holding down Ctrl/Cmd+Click. Add tags to the annotation will make it searchable from other dashboards. {{< docs-imagebox img="/img/docs/annotations/annotation-still.png" max-width="600px" animated-gif="/img/docs/annotations/annotation.gif" >}} ### Adding regions events -You can also hold down **CTRL** or **CMD** and select region to create a region annotation. +You can also hold down Ctrl/Cmd and select region to create a region annotation. {{< docs-imagebox img="/img/docs/annotations/region-annotation-still.png" max-width="600px" animated-gif="/img/docs/annotations/region-annotation.gif" >}}