diff --git a/assets/styles/layouts/_inline-icons.scss b/assets/styles/layouts/_inline-icons.scss index 07f5b47e1..eb01763cf 100644 --- a/assets/styles/layouts/_inline-icons.scss +++ b/assets/styles/layouts/_inline-icons.scss @@ -21,6 +21,28 @@ padding-left: .28rem; line-height: 1.25rem; } + + &.ui-toggle { + display: inline-block; + position: relative; + width: 34px; + height: 22px; + background: #1C1C21; + border: 2px solid #383846; + border-radius: .7rem; + vertical-align: text-bottom; + + .circle { + display: inline-block; + position: absolute; + border-radius: 50%; + height: 12px; + width: 12px; + background: #22ADF6; + top: 3px; + right: 3px; + } + } } .nav-icon { diff --git a/content/v2.0/process-data/_index.md b/content/v2.0/process-data/_index.md index 4d8761769..0e8e2f017 100644 --- a/content/v2.0/process-data/_index.md +++ b/content/v2.0/process-data/_index.md @@ -11,11 +11,11 @@ weight: 5 v2.0/tags: [tasks] --- -Process and analyze your data with tasks in the InfluxDB _**task engine**. Use tasks (scheduled Flux queries) +Process and analyze your data with tasks in the InfluxDB **task engine**. Use tasks (scheduled Flux queries) to input a data stream and then analyze, modify, and act on the data accordingly. -Discover how to configure and build tasks using the InfluxDB user interface (UI) and the `influx` command line interface (CLI). -Find examples of data downsampling, anomaly detection_(Coming)_, alerting _(Coming)_, and other common tasks. +Discover how to configure and build tasks using the InfluxDB user interface (UI) and the `influx` command line interface (CLI). +Find examples of data downsampling, anomaly detection _(Coming)_, alerting _(Coming)_, and other common tasks. {{% note %}} Tasks replace InfluxDB v1.x's continuous queries. diff --git a/content/v2.0/process-data/write-a-task.md b/content/v2.0/process-data/get-started.md similarity index 94% rename from content/v2.0/process-data/write-a-task.md rename to content/v2.0/process-data/get-started.md index 138733095..4a09eeec0 100644 --- a/content/v2.0/process-data/write-a-task.md +++ b/content/v2.0/process-data/get-started.md @@ -1,13 +1,15 @@ --- -title: Write an InfluxDB task -seotitle: Write an InfluxDB task that processes data +title: Get started with InfluxDB tasks +list_title: Get started with tasks description: > - How to write an InfluxDB task that processes data in some way, then performs an action + Learn the basics of writing an InfluxDB task that processes data and then performs an action such as storing the modified data in a new bucket or sending an alert. +aliases: + - /v2.0/process-data/write-a-task/ v2.0/tags: [tasks] menu: v2_0: - name: Write a task + name: Get started with tasks parent: Process data weight: 101 --- diff --git a/content/v2.0/process-data/manage-tasks/_index.md b/content/v2.0/process-data/manage-tasks/_index.md index 12fe7654b..66bc24c75 100644 --- a/content/v2.0/process-data/manage-tasks/_index.md +++ b/content/v2.0/process-data/manage-tasks/_index.md @@ -1,9 +1,10 @@ --- title: Manage tasks in InfluxDB seotitle: Manage data processing tasks in InfluxDB +list_title: Manage tasks description: > InfluxDB provides options for managing the creation, reading, updating, and deletion - of tasks using both the 'influx' CLI and the InfluxDB UI. + of tasks using both the `influx` CLI and the InfluxDB UI. v2.0/tags: [tasks] menu: v2_0: diff --git a/content/v2.0/process-data/manage-tasks/create-task.md b/content/v2.0/process-data/manage-tasks/create-task.md index 13944a48f..b5191e19d 100644 --- a/content/v2.0/process-data/manage-tasks/create-task.md +++ b/content/v2.0/process-data/manage-tasks/create-task.md @@ -3,7 +3,7 @@ title: Create a task seotitle: Create a task for processing data in InfluxDB description: > How to create a task that processes data in InfluxDB using the InfluxDB user - interface or the 'influx' command line interface. + interface or the `influx` command line interface. menu: v2_0: name: Create a task @@ -14,7 +14,7 @@ weight: 201 InfluxDB provides multiple ways to create tasks both in the InfluxDB user interface (UI) and the `influx` command line interface (CLI). -_This article assumes you have already [written a task](/v2.0/process-data/write-a-task)._ +_This article assumes you have already [written a task](/v2.0/process-data/get-started)._ ## Create a task in the InfluxDB UI The InfluxDB UI provides multiple ways to create a task: @@ -22,6 +22,8 @@ The InfluxDB UI provides multiple ways to create a task: - [Create a task from the Data Explorer](#create-a-task-from-the-data-explorer) - [Create a task in the Task UI](#create-a-task-in-the-task-ui) - [Import a task](#import-a-task) +- [Create a task from a template](#create-a-task-from-a-template) +- [Clone a task](#clone-a-task) ### Create a task from the Data Explorer 1. Click on the **Data Explorer** icon in the left navigation menu. @@ -41,11 +43,12 @@ The InfluxDB UI provides multiple ways to create a task: {{< nav-icon "tasks" >}} -2. Click **+ Create Task** in the upper right. -3. In the left panel, specify the task options. +2. Click **{{< icon "plus" >}} Create Task** in the upper right. +3. Select **New Task**. +4. In the left panel, specify the task options. See [Task options](/v2.0/process-data/task-options)for detailed information about each option. -4. In the right panel, enter your task script. -5. Click **Save** in the upper right. +5. In the right panel, enter your task script. +6. Click **Save** in the upper right. {{< img-hd src="/img/2-0-tasks-create-edit.png" title="Create a task" />}} @@ -56,8 +59,19 @@ The InfluxDB UI provides multiple ways to create a task: 2. Click **+ Create Task** in the upper right. 3. Select **Import Task**. -3. Drag and drop or select a file to upload. -4. Click **Import JSON as Task**. +4. Upload a JSON task file by either dragging and dropping it in the specified area + or click the area to select a file to upload. Select the **JSON** option to paste + in raw task JSON. +5. Click **Import JSON as Task**. + +### Create a task from a template +1. Click on the **Settings** icon in the left navigation menu. + + {{< nav-icon "Settings" >}} + +2. Select **Templates**. +3. Hover over the template to use to create the task and click **Create**. + ### Clone a task 1. Click on the **Tasks** icon in the left navigation menu. diff --git a/content/v2.0/process-data/manage-tasks/delete-task.md b/content/v2.0/process-data/manage-tasks/delete-task.md index 8343a727d..d31ef5655 100644 --- a/content/v2.0/process-data/manage-tasks/delete-task.md +++ b/content/v2.0/process-data/manage-tasks/delete-task.md @@ -3,7 +3,7 @@ title: Delete a task seotitle: Delete a task for processing data in InfluxDB description: > How to delete a task in InfluxDB using the InfluxDB user interface or using - the 'influx' command line interface. + the `influx` command line interface. menu: v2_0: name: Delete a task diff --git a/content/v2.0/process-data/manage-tasks/export-task.md b/content/v2.0/process-data/manage-tasks/export-task.md index d491698b7..a7a1c8812 100644 --- a/content/v2.0/process-data/manage-tasks/export-task.md +++ b/content/v2.0/process-data/manage-tasks/export-task.md @@ -18,7 +18,7 @@ Tasks are exported as downloadable JSON files. {{< nav-icon "tasks" >}} 2. In the list of tasks, hover over the task you would like to export and click - the **{{< icon "gear" >}}** that appears. + the **{{< icon "gear" >}}** icon that appears. 3. Select **Export**. 4. There are multiple options for downloading or saving the task export file: - Click **Download JSON** to download the exported JSON file. diff --git a/content/v2.0/process-data/manage-tasks/update-task.md b/content/v2.0/process-data/manage-tasks/update-task.md index 4005ee51f..366a7653e 100644 --- a/content/v2.0/process-data/manage-tasks/update-task.md +++ b/content/v2.0/process-data/manage-tasks/update-task.md @@ -3,7 +3,7 @@ title: Update a task seotitle: Update a task for processing data in InfluxDB description: > How to update a task that processes data in InfluxDB using the InfluxDB user - interface or the 'influx' command line interface. + interface or the `influx` command line interface. menu: v2_0: name: Update a task @@ -25,8 +25,8 @@ To view your tasks, click the **Tasks** icon in the left navigation menu. {{< img-hd src="/img/2-0-tasks-create-edit.png" alt="Update a task" />}} #### Update the status of a task -In the list of tasks, click the toggle in the **Active** column of the task you -would like to activate or inactivate. +In the list of tasks, click the {{< icon "toggle" >}} toggle to the left of the +task you would like to activate or inactivate. ## Update a task with the influx CLI diff --git a/content/v2.0/process-data/manage-tasks/view-tasks.md b/content/v2.0/process-data/manage-tasks/view-tasks.md index db55b6a94..76fb7b7c7 100644 --- a/content/v2.0/process-data/manage-tasks/view-tasks.md +++ b/content/v2.0/process-data/manage-tasks/view-tasks.md @@ -3,7 +3,7 @@ title: View tasks seotitle: View created tasks that process data in InfluxDB description: > How to view all created data processing tasks using the InfluxDB user interface - or the 'influx' command line interface. + or the `influx` command line interface. menu: v2_0: name: View tasks @@ -18,10 +18,10 @@ Click the **Tasks** icon in the left navigation to view the lists of tasks. ### Filter the list of tasks -1. Enable the **Show Inactive** option to include inactive tasks in the list. -2. Enter text in the **Filter tasks by name** field to search for tasks by name. -3. Select an organization from the **All Organizations** dropdown to filter the list by organization. -4. Click on the heading of any column to sort by that field. +1. Click the **Show Inactive** {{< icon "toggle" >}} toggle to include or exclude + inactive tasks in the list. +2. Enter text in the **Filter tasks** field to search for tasks by name or label. +3. Click on the heading of any column to sort by that field. ## View tasks with the influx CLI Use the `influx task find` command to return a list of created tasks. diff --git a/layouts/shortcodes/icon.html b/layouts/shortcodes/icon.html index 931f4a2fa..bb08a69a6 100644 --- a/layouts/shortcodes/icon.html +++ b/layouts/shortcodes/icon.html @@ -56,4 +56,6 @@ {{ else if eq $icon "add-label" }} +{{ else if eq $icon "toggle" }} + {{ end }}