Docs: 8.0 panel edit updates (#34533)

* Update timeseries.md

* Update add-a-panel.md

* Update _index.md

* Update panel-editor.md

* content updates

* content edits

* moved repeat panels topic

* Update getting-started.md

* edits

* Update DRAFT.md
This commit is contained in:
Diana Payton 2021-05-20 14:16:15 -07:00 committed by GitHub
parent 676ddac088
commit 0ee0d65e12
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 84 additions and 69 deletions

View File

@ -1,5 +1,5 @@
+++
title = "Time series"
title = "Intro to time series"
description = "Introduction to time series"
keywords = ["grafana", "intro", "guide", "concepts", "timeseries"]
weight = 400

View File

@ -22,7 +22,7 @@ To log in to Grafana for the first time:
1. Open your web browser and go to http://localhost:3000/. The default HTTP port that Grafana listens to is `3000` unless you have configured a different port.
1. On the login page, enter `admin` for username and password.
1. Click **Log In**. If login is successful, then you will see a prompt to change the password.
1. Click **Log in**. If login is successful, then you will see a prompt to change the password.
1. Click **OK** on the prompt, then change your password.
> **Note:** We strongly recommend that you follow Grafana's best practices and change the default administrator password. Don't forget to record your credentials!
@ -31,8 +31,9 @@ To log in to Grafana for the first time:
To create your first dashboard:
1. Click the **+** icon on the left panel, select **Create Dashboard**, and then click **Add an empty panel**.
1. In the New Dashboard/Edit Panel view, go to the **Query** tab.
1. Click the **+** icon on the side menu.
1. On the dashboard, click **Add an empty panel**.
1. In the New dashboard/Edit panel view, go to the **Query** tab.
1. Configure your [query]({{< relref "../panels/queries.md" >}}) by selecting ``-- Grafana --`` from the [data source selector]({{< relref "../panels/queries.md/#data-source-selector" >}}). This generates the Random Walk dashboard.
1. Click the **Save** icon in the top right corner of your screen to save the dashboard.
1. Add a descriptive name, and then click **Save**.

View File

@ -8,7 +8,7 @@ weight = 300
# Panel links
Each panel can have its own set of links that are shown in the upper left corner of the panel. You can link to any available URL, including dashboards, panels, or external sites. You can even control the time range to ensure the user is zoomed in on the right data in Grafana.
{{< docs/shared "panels/panel-links-intro.md" >}}
Click the icon on the top left corner of a panel to see available panel links.

View File

@ -1,58 +1,24 @@
+++
draft = "true"
description = "A topic to collect my thoughts and plans for Grafana 8.0. Can delete after that."
+++
Task: Add panel
Default visualization: Time series
- change if you want to, or go to query
Get data into your panel
- Select data source
- Add query and/or expression
- Transform data
- Troubleshoot
- Query options
- Inspect query
- Table view
Make it look good
- Change the visualization
- Panel options
- Visualization-specific options
- Thresholds
- Standard options
- Value mappings
- Data links
- Overrides
Next steps
- Set up alert
TOC
# General
Add a panel
Panel editor
# Work with your metrics
Queries
- Share query results
- Mixed data source queries
Expressions
- Mixed data source queries (not yet written)
Expressions (beta)
Transformations
Inspect a panel
# Adjust appearance
Panel options
Visualization-specific settings (Visualizations)
Thresholds
Value mappings
Data links (can be for all fields or one)
Visualizations > specific options
Overrides

View File

@ -16,30 +16,34 @@ Panels allow you to show your data in visual form. This topic walks you through
1. Click **Add an empty panel**.
Grafana creates an empty graph panel with your default data source selected.
Grafana creates an empty time series panel with your default data source selected.
## 2. Edit panel settings
While not required, we recommend that you add a helpful title and description to your panel. You can use [variables you have defined]({{< relref "../variables/_index.md" >}}) in either field, but not [global variables]({{< relref "../variables/variable-types/global-variables.md" >}}).
![](/img/docs/panels/panel-settings-7-0.png)
**Panel title -** Text entered in this field is displayed at the top of your panel in the panel editor and in the dashboard.
**Description -** Text entered in this field is displayed in a tooltip in the upper left corner of the panel. Write a description of the panel and the data you are displaying. Pretend you are explaining it to a new user six months from now, when it is no longer fresh in your mind. Future editors (possibly yourself) will thank you.
## 3. Write a query
## 2. Write a query
Each panel needs at least one query to display a visualization. You write queries in the Query tab of the panel editor. For more information about the Query tab, refer to [Queries]({{< relref "queries.md" >}}).
1. Choose a data source. In the first line of the Query tab, click the drop-down list to see all available data sources. This list includes all data sources you added. Refer to [Add a data source]({{< relref "../datasources/add-a-data-source.md" >}}) if you need instructions.
1. Write or construct a query in the query language of your data source. Options will vary. Refer to your specific [data source documentation]({{< relref "../datasources/_index.md" >}}) for specific guidelines.
## 4. Choose a visualization type
## 3. Choose a visualization type
In the Visualization section of the Panel tab, click a visualization type. Grafana displays a preview of your query results with that visualization applied.
In the Visualization list, click a visualization type. Grafana displays a preview of your query results with that visualization applied.
For more information about individual visualizations, refer to [Visualizations]({{< relref "visualizations/_index.md" >}}).
![](/img/docs/panel-editor/select-visualization-8-0.png)
For more information about individual visualizations, refer to [Visualizations options]({{< relref "visualizations/_index.md" >}}).
## 4. (Optional) Edit panel settings
While not required, most visualizations need some adjustment before they properly display the information that you need. Options are defined in the linked topics below.
- [Panel options]({{< relref "./panel-options.md" >}})
- [Visualization-specific options]({{< relref "./visualizations/_index.md" >}})
- [Standard options]({{< relref "./standard-options.md" >}})
- [Thresholds]({{< relref "./thresholds.md" >}})
- [Value mappings]({{< relref "./value-mappings.md" >}})
- [Data links]({{< relref "../linking/data-links.md" >}})
- [Override fields]({{< relref "field-options/configure-specific-fields.md" >}})
## 5. Apply changes and save
@ -54,7 +58,5 @@ Our Grafana Fundamentals tutorial is a great place to start, or you can learn mo
- Learn more about [panel editor]({{< relref "panel-editor.md" >}}) options.
- Add more [queries]({{< relref "queries.md" >}}).
- [Transform]({{< relref "transformations/_index.md" >}}) your data.
- [Configure]({{< relref "field-options/_index.md" >}}) how your results are displayed in the visualization.
- If you made a graph panel, set up an [alert]({{< relref "../alerting/_index.md" >}}).
- Set up an [alert]({{< relref "../alerting/_index.md" >}}).
- Create [templates and variables]({{< relref "../variables/_index.md" >}}).

View File

@ -1,7 +1,7 @@
+++
title = "Legend options"
aliases = ["/docs/grafana/latest/panels/visualizations/panel-legend/"]
weight = 500
weight = 950
+++
# Legend options

View File

@ -68,7 +68,6 @@ The section contains tabs where you control almost every aspect of how your data
Features in these tabs are documented in the following topics:
- [Add a panel]({{< relref "add-a-panel.md" >}}) describes basic panel settings.
- [Visualizations]({{< relref "visualizations/_index.md" >}}) display options vary widely. They are described in the individual visualization topic.
- [Visualization]({{< relref "visualizations/_index.md" >}}) options vary widely. They are described in the individual visualization topic.
- [Field options and overrides]({{< relref "field-options/_index.md" >}}) allow you to control almost every aspect of your visualization, including units, value mappings, and [Thresholds]({{< relref "thresholds.md" >}}).
- [Panel links]({{< relref "../linking/panel-links.md" >}}) and [Data links]({{< relref "../linking/data-links.md" >}}) help you connect your visualization to other resources.

View File

@ -0,0 +1,38 @@
+++
title = "Panel options"
weight = 900
+++
# Panel options
Panel options are common to all panels. They are basic options to add information and clarity to your panels. Fields are described below.
While not required, we recommend that you add a helpful title and description to all panels.
![](/img/docs/panels/panel-options-8-0.png)
## Title
Text entered in this field is displayed at the top of your panel in the panel editor and in the dashboard. You can use [variables you have defined]({{< relref "../variables/_index.md" >}}) in either field, but not [global variables]({{< relref "../variables/variable-types/global-variables.md" >}}).
## Description
Text entered in this field is displayed in a tooltip in the upper left corner of the panel. Write a description of the panel and the data you are displaying. Pretend you are explaining it to a new user six months from now, when it is no longer fresh in your mind. Future editors (possibly yourself) will thank you.
You can use [variables you have defined]({{< relref "../variables/_index.md" >}}) in either field, but not [global variables]({{< relref "../variables/variable-types/global-variables.md" >}}).
## Transparent background
Toggle the transparent background option on your panel display.
## Panel links
{{< docs/shared "panels/panel-links-intro.md" >}}
For more information, refer to [Panel links]({{< relref "../linking/panel-links.md" >}}).
## Repeat options
{{< docs/shared "panels/repeat-panels-intro.md" >}}
For more information, refer to [Repeat panels or rows]({{< relref "./repeat-panels-or-rows.md" >}}).

View File

@ -1,12 +1,13 @@
+++
title = "Repeat panels or rows"
keywords = ["grafana", "templating", "documentation", "guide", "template", "variable", "repeat"]
aliases = ["/docs/grafana/latest/variables/repeat-panels-or-rows/"]
weight = 800
+++
# Repeat panels or rows
Grafana lets you create dynamic dashboards using _template variables_. All variables in your queries expand to the current value of the variable before the query is sent to the database. Variables let you reuse a single dashboard for all your services.
{{< docs/shared "panels/repeat-panels-intro.md" >}}
Template variables can be very useful to dynamically change your queries across a whole dashboard. If you want
Grafana to dynamically create new panels or rows based on what values you have selected, you can use the _Repeat_ feature.

View File

@ -1,12 +1,10 @@
+++
title = "Visualizations"
title = "Visualization options"
weight = 300
+++
# Visualizations
# Visualization options
Grafana offers a variety of visualizations to suit different use cases. This section of the documentation lists the different visualizations available in Grafana and their unique display settings.
The default options and their unique display options are described in the pages in this section.
Grafana offers a variety of visualizations to suit different use cases. This section of the documentation lists the different visualizations available in Grafana and their unique options.
You can add more panel types with [plugins]({{< relref "../../plugins/_index.md" >}}).

View File

@ -0,0 +1,5 @@
---
title: Panel links intro
---
Each panel can have its own set of links that are shown in the upper left corner of the panel. You can link to any available URL, including dashboards, panels, or external sites. You can even control the time range to ensure the user is zoomed in on the right data in Grafana.

View File

@ -0,0 +1,5 @@
---
title: Repeat panel intro
---
Grafana lets you create dynamic dashboards using _template variables_. All variables in your queries expand to the current value of the variable before the query is sent to the database. Variables let you reuse a single dashboard for all your services.