WIP updating UI instructions, documented dark and light mode, resolves #832

pull/865/head
Scott Anderson 2020-03-25 15:06:53 -06:00
parent 97688a2ec2
commit 108bde769a
13 changed files with 33 additions and 87 deletions

View File

@ -1,5 +1,5 @@
---
title: Get started with InfluxDB
title: Get started with InfluxDB OSS
description: Download, install, and setup InfluxDB, creating a default organization, user, and bucket.
menu:
v2_0:
@ -8,7 +8,7 @@ weight: 1
v2.0/tags: [get-started, install]
---
Get started with InfluxDB v2.0 by downloading InfluxDB, installing the necessary
Get started with InfluxDB OSS v2.0 by downloading InfluxDB, installing the necessary
executables, and running the initial setup process.
{{% cloud-msg %}}

View File

@ -16,13 +16,13 @@ Use dashboard controls in the upper right to update your dashboard.
### Add a cell
Click {{< icon "add-cell" >}} **Add Cell** to open the Data Explorer and configure a new cell for your dashboard.
Click **{{< icon "add-cell" >}} Add Cell** to open the Data Explorer and configure a new cell for your dashboard.
For details on using the Data Explorer, see [Explore metrics](/v2.0/visualize-data/explore-metrics/).
### Add a note
1. Click {{< icon "note" >}} **Add Note** to add a note cell to your dashboard.
1. Click **{{< icon "note" >}} Add Note** to add a note cell to your dashboard.
2. Enter your note in Markdown in the left pane. A preview appears in the right pane.
3. Enable the **Show note when query returns no data** option to show the note only when the query displays no data.
4. Click **Save**.
@ -41,7 +41,7 @@ Select how frequently to refresh the dashboard's data. By default, refreshing is
### Manually refresh dashboard
Click the refresh button ({{< icon "refresh" >}}) to manually refresh the dashboard's data.
Click the refresh button (**{{< icon "refresh" >}}**) to manually refresh the dashboard's data.
### Select time range
@ -58,4 +58,9 @@ Click **Variables** to display variables available for your dashboard. For detai
### Presentation mode
Click the fullscreen icon ({{< icon "fullscreen" >}}) to enter presentation mode. Presentation mode allows you to view [a dashboard] in full screen, hiding the left and top navigation menus so only the cells appear. This mode might be helpful, for example, for stationary screens dedicated to monitoring visualizations.
Click the fullscreen icon (**{{< icon "fullscreen" >}}**) to enter presentation mode. Presentation mode allows you to view [a dashboard] in full screen, hiding the left and top navigation menus so only the cells appear. This mode might be helpful, for example, for stationary screens dedicated to monitoring visualizations.
### Toggle dark mode and light mode
Click the moon or sun icons to toggle your dashboard between **dark mode** and **light mode.**
{{< img-hd src="/img/2-0-controls-dark-light-mode.png" alt="Dark & light mode"/>}}

View File

@ -19,7 +19,7 @@ weight: 201
{{< nav-icon "dashboards" >}}
2. Click the **+Create Dashboard** menu in the upper right and select **New Dashboard**.
2. Click the **{{< icon "plus" >}} Create Dashboard** menu in the upper right and select **New Dashboard**.
3. Enter a name for your dashboard in the **Name this dashboard** field in the upper left.
@ -63,20 +63,20 @@ weight: 201
## Clone a dashboard
1. Hover over the dashboard name in the list of dashboard to show options.
1. Hover over the dashboard in the list of dashboard and click **{{< icon "copy" >}}**.
2. Click **Clone**. The cloned dashboard opens.
#### Add data to your dashboard
1. From your dashboard, click **Add Cell** (**{{< icon "add-cell" >}}**) in the upper right. The Data Explorer overlay opens.
1. From your dashboard, click **{{< icon "add-cell" >}} Add Cell**. The Data Explorer overlay opens.
2. Create a query in the Data Explorer following the instructions in [Explore metrics](/v2.0/visualize-data/explore-metrics).
3. Enter a name for your cell in the upper left.
4. Click the checkmark icon (**{{< icon "checkmark" >}}**) to save the cell to your dashboard.
You can also send data to your dashboard directly from the Data Explorer. For details, [Explore metrics](/v2.0/visualize-data/explore-metrics).
#### Add a note to your dashboard
1. From your dashboard, click **Add Note** in the upper right.
1. From your dashboard, click **{{< icon "note" >}} Add Note** in the upper right.
2. Enter your note in the window that appears. You can use Markdown syntax to format your note.
3. To preview your Markdown formatting, click the **Preview** option.
4. Click **Save**.

View File

@ -11,9 +11,8 @@ weight: 204
To delete a dashboard from the InfluxDB user interface (UI):
1. Hover over the dashboard name in the list of dashboards to show options.
2. Click **{{< icon "trash" >}}**.
3. Click **Delete** to delete your dashboard.
1. Hover over the dashboard in the list of dashboards and click **{{< icon "trash" >}}**.
2. Click **Delete** to delete your dashboard.
{{% warn %}}
Deleting a dashboard cannot be undone.

View File

@ -19,7 +19,8 @@ InfluxDB lets you export dashboards from the InfluxDB user interface (UI).
{{< nav-icon "dashboards" >}}
2. Hover over a dashboard in the list, then click the gear icon ({{< icon "gear" >}}) and select **Export**.
2. Hover over a dashboard in the list, click the gear icon (**{{< icon "gear" >}}**),
and then select **Export**.
3. Review the JSON in the window that appears.
4. Select one of the following options:
* **Download JSON**: Download the dashboard as a JSON file.

View File

@ -1,20 +0,0 @@
---
title: Update a dashboard
seotitle: Update an InfluxDB dashboard
description: Update an InfluxDB dashboard in the InfluxDB user interface (UI).
v2.0/tags: [dashboards]
menu:
v2_0:
name: Update a dashboard
parent: Manage dashboards
weight: 202
draft: true
---
**Notes:**
- Dashboard name
- Dashboard description
- Labels
- Dashboard cells
- etc.

View File

@ -25,7 +25,7 @@ To manage labels:
2. Enter a **Name** for the label.
3. Enter a description for the label _(Optional)_.
4. Select a **Color** for the label.
5. Click **Create label**.
5. Click **Create Label**.
#### Edit a label
1. In the label list view, click the name of the label you would like to edit.
@ -34,8 +34,8 @@ To manage labels:
3. Click **Save Changes**.
#### Delete a label
1. In the label list view, hover over the label you would like to delete.
2. Click **Delete** in the far right of the label row.
1. In the label list view, hover over the label you would like to delete and click **{{< icon "trash" >}}**.
2. Click **Delete**.
### Add labels to dashboard items
1. In the list view of dashboards, tasks, or other assets, hover over the item to which you would like to add a label.

View File

@ -1,41 +0,0 @@
---
title: Manage sources
description: InfluxDB offers a complete dashboard solution for visualizing your data and monitoring your infrastructure.
v2.0/tags: [sources]
menu:
v2_0:
name: Manage sources
parent: Visualize data
weight: 101
---
Like dashboards and buckets, data sources are scoped by organization. When you first access the user interface, you'll be prompted to add a data source. You can also do so anytime using the steps below.
**To add data to a bucket**:
1. Click the **Settings** tab in the navigation bar.
{{< nav-icon "settings" >}}
2. Click the **Buckets** tab.
3. Next to the name of a bucket, click **Add Data**.
4. Select **Streaming**, **Line Protocol**, or **Scraping** from the data source options.
5. Click **Continue**.
6. Follow the prompts add your data source.
**To manage Telegraf configurations**:
1. Click the **Settings** tab in the navigation bar.
{{< nav-icon "settings" >}}
2. Click the **Telegraf** tab. A list of existing Telegraf configurations appears.
3. To add a new Telegraf configuration:
* Click **Create Configuration** in the upper right.
* Select the Telegraf plugins you want to use to collect data.
* Click **Continue**.
* Follow the instructions on the **Listen for Streaming Data** page that appears to complete your configuration.
4. To delete a Telegraf configuration, hover over its name in the list and click **Delete**.
5. To view details of a Telegraf configuration, click on its name in the list.
- To save the Telegraf configuration, click **Download Config**.

View File

@ -31,8 +31,9 @@ weight: 201
{{< nav-icon "dashboards" >}}
2. Click the settings icon ({{< icon "gear" >}}) next to a dashboard in the list, then click **Export**. The dashboard JSON appears in a new window.
3. Click **Save as template**.
2. Hover over the dashboard you want to use the create the template and click **{{< icon "gear" >}}**.
3. Click **Export**. The dashboard JSON appears in a new window.
4. Click **Save as template**.
## Clone a template
@ -42,5 +43,5 @@ weight: 201
{{< nav-icon "settings" >}}
2. Select the **Templates** tab.
3. Hover over the template you want to clone, then click {{< icon "clone" >}}.
3. Hover over the template you want to clone and click **{{< icon "clone" >}}**.
4. Click **Clone** to confirm. The cloned template appears in your list.

View File

@ -82,9 +82,10 @@ To write data into InfluxDB, use one of the following methods:
To quickly start writing data, use the provided user interface.
1. Do one of the following:
- _InfluxDB 2.0 OSS users_:
In your terminal, run `influxd` and then in your browser, go to the location where you're hosting the UI (by default, localhost:9999).
- _InfluxDB 2.0 Cloud users_:
- _**InfluxDB 2.0 OSS**_:
In your terminal, run `influxd` and then in your browser, go to the location
where you're hosting the UI (by default, **localhost:9999**).
- _**InfluxDB 2.0 Cloud**_:
In your browser, go to https://cloud2.influxdata.com/.
2. Click **Load Data** in the navigation menu on the left.
3. Select **Buckets**.

View File

@ -34,7 +34,7 @@ for using Telegraf with InfluxDB v2.0._
{{< nav-icon "load data" >}}
3. Select **Telegrafs**.
3. Select **Telegraf**.
4. Click **{{< icon "plus" >}} Create Configuration**.
5. In the **Bucket** dropdown, select the bucket where Telegraf will store collected data.
6. Select one or more of the available plugin groups and click **Continue**.
@ -59,7 +59,7 @@ for using Telegraf with InfluxDB v2.0._
If you plan to monitor a Windows host using the System plugin, you must complete the following steps.
1. In the list of Telegraf configurations, double-click your
1. In the list of Telegraf configurations, double-click your
Telegraf configuration, and then click **Download Config**.
2. Open the downloaded Telegraf configuration file and replace the `[[inputs.processes]]` plugin with one of the following Windows plugins, depending on your Windows configuration:
@ -109,7 +109,7 @@ $env:INFLUX_TOKEN = “YourAuthenticationToken"
{{% code-tab-content %}}
```sh
set INFLUX_TOKEN=YourAuthenticationToken
set INFLUX_TOKEN=YourAuthenticationToken
# Make sure to include a space character at the end of this command.
```
{{% /code-tab-content %}}

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 17 KiB