From dd83b67de589f0a006dfc46b96e00651fdf04ed4 Mon Sep 17 00:00:00 2001 From: Patrick O'Carroll Date: Tue, 3 Oct 2017 13:34:52 +0200 Subject: [PATCH] Docs text fixes (#9408) * styling changes and some text changes * styling changes --- docs/sources/features/panels/table_panel.md | 28 ++++++++++----------- docs/sources/features/panels/text.md | 4 +-- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/sources/features/panels/table_panel.md b/docs/sources/features/panels/table_panel.md index 9c112c81265..a3e56c72960 100644 --- a/docs/sources/features/panels/table_panel.md +++ b/docs/sources/features/panels/table_panel.md @@ -25,8 +25,8 @@ The table panel has many ways to manipulate your data for optimal presentation. {{< docs-imagebox img="/img/docs/v45/table_options.png" class="docs-image--no-shadow" max-width= "500px" >}} -1. `Data`: Control how your query is transformed into a table. -2. `Paging`: Table display options. +1. **Data**: Control how your query is transformed into a table. +2. **Paging**: Table display options. ## Data to Table @@ -43,20 +43,20 @@ you want in the table. Only applicable for some transforms. {{< docs-imagebox img="/img/docs/v45/table_ts_to_rows.png" >}} -In the most simple mode you can turn time series to rows. This means you get a `Time`, `Metric` and a `Value` column. Where `Metric` is the name of the time series. +In the most simple mode you can turn time series to rows. This means you get a **Time**, **Metric** and a **Value** column. Where **Metric** is the name of the time series. ### Time series to columns {{< docs-imagebox img="/img/docs/v45/table_ts_to_columns.png" >}} -This transform allows you to take multiple time series and group them by time. Which will result in the primary column being `Time` and a column for each time series. +This transform allows you to take multiple time series and group them by time. Which will result in the primary column being **Time** and a column for each time series. ### Time series aggregations {{< docs-imagebox img="/img/docs/v45/table_ts_to_aggregations.png" >}} -This table transformation will lay out your table into rows by metric, allowing columns of `Avg`, `Min`, `Max`, `Total`, `Current` and `Count`. More than one column can be added. +This table transformation will lay out your table into rows by metric, allowing columns of **Avg**, **Min**, **Max**, **Total**, **Current** and **Count**. More than one column can be added. ### Annotations @@ -70,7 +70,7 @@ mode then any queries you have in the metrics tab will be ignored. {{< docs-imagebox img="/img/docs/v45/table_json_data.png" max-width="500px" >}} -If you have an Elasticsearch **Raw Document** query or an Elasticsearch query without a `date histogram` use this +If you have an Elasticsearch **Raw Document** query or an Elasticsearch query without a **date histogram** use this transform mode and pick the columns using the **Columns** section. @@ -80,9 +80,9 @@ transform mode and pick the columns using the **Columns** section. {{< docs-imagebox img="/img/docs/v45/table_paging.png" class="docs-image--no-shadow docs-image--right" max-width="350px" >}} -1. `Pagination (Page Size)`: The table display fields allow you to control The `Pagination` (page size) is the threshold at which the table rows will be broken into pages. For example, if your table had 95 records with a pagination value of 10, your table would be split across 9 pages. -2. `Scroll`: The `scroll bar` checkbox toggles the ability to scroll within the panel, when unchecked, the panel height will grow to display all rows. -3. `Font Size`: The `font size` field allows you to increase or decrease the size for the panel, relative to the default font size. +1. **Rows Per Page**: The table display fields allow you to control how many rows per page there should be. For example, if your table had 95 records with a rows per page value of 10, your table would be split across 10 pages. +2. **Scroll**: The scroll bar checkbox toggles the ability to scroll within the panel, when unchecked, the panel height will grow to display all rows. +3. **Font Size**: The font size field allows you to increase or decrease the size for the panel, relative to the default font size. ## Column Styles @@ -91,9 +91,9 @@ The column styles allow you control how dates and numbers are formatted. {{< docs-imagebox img="/img/docs/v45/table_column_styles.png" class="docs-image--no-shadow" >}} -1. `Name or regex`: The Name or Regex field controls what columns the rule should be applied to. The regex or name filter will be matched against the column name not against column values. -2. `Column Header`: Title for the column, when using a Regex the title can include replacement strings like `$1`. -3. `Add column style rule`: Add new column rule. -4. `Thresholds` and `Coloring`: Specify color mode and thresholds limits. -5. `Type`: The three supported types of types are `Number`, `String` and `Date`. `Unit` and `Decimals`: Specify unit and decimal precision for numbers.`Format`: Specify date format for dates. +1. **Name or regex**: The Name or Regex field controls what columns the rule should be applied to. The regex or name filter will be matched against the column name not against column values. +2. **Column Header**: Title for the column, when using a Regex the title can include replacement strings like `$1`. +3. **Add column style rule**: Add new column rule. +4. **Thresholds and Coloring**: Specify color mode and thresholds limits. +5. **Type**: The three supported types of types are **Number**, **String** and **Date**. **Unit** and **Decimals**: Specify unit and decimal precision for numbers. **Format**: Specify date format for dates. diff --git a/docs/sources/features/panels/text.md b/docs/sources/features/panels/text.md index ae37df16b9e..cc8269793bd 100644 --- a/docs/sources/features/panels/text.md +++ b/docs/sources/features/panels/text.md @@ -18,6 +18,6 @@ The text panel lets you make information and description panels etc. for your da {{< docs-imagebox img="/img/docs/v45/text-options.png" max-width="600px" class="docs-image--no-shadow">}} -1. `Mode`: Here you can choose between markdown, HTML or text. -2. `Content`: Here you write your content. +1. **Mode**: Here you can choose between markdown, HTML or text. +2. **Content**: Here you write your content.