changes to task docs based on PR feedback

pull/106/head
Scott Anderson 2019-03-26 13:29:16 -06:00
parent 7c1f933ade
commit 823fa2e118
7 changed files with 16 additions and 23 deletions

View File

@ -2,8 +2,7 @@
title: Create a task title: Create a task
seotitle: Create a task for processing data in InfluxDB seotitle: Create a task for processing data in InfluxDB
description: > description: >
Create a data processing task in InfluxDB using the InfluxDB user interface or Create a data processing task in InfluxDB using the InfluxDB UI or the `influx` CLI.
the `influx` command line interface.
menu: menu:
v2_0: v2_0:
name: Create a task name: Create a task

View File

@ -2,8 +2,7 @@
title: Delete a task title: Delete a task
seotitle: Delete a task for processing data in InfluxDB seotitle: Delete a task for processing data in InfluxDB
description: > description: >
Delete a task from InfluxDB using the InfluxDB user interface or using the Delete a task from InfluxDB using the InfluxDB UI or the `influx` CLI.
`influx` command line interface.
menu: menu:
v2_0: v2_0:
name: Delete a task name: Delete a task

View File

@ -1,7 +1,7 @@
--- ---
title: Export a task title: Export a task
seotitle: Export an InfluxDB task seotitle: Export an InfluxDB task
description: Export a data processing task from InfluxDB using the InfluxDB user interface. description: Export a data processing task from InfluxDB using the InfluxDB UI.
menu: menu:
v2_0: v2_0:
name: Export a task name: Export a task
@ -9,7 +9,7 @@ menu:
weight: 205 weight: 205
--- ---
InfluxDB allows you to export tasks from the InfluxDB user interface (UI). InfluxDB lets you export tasks from the InfluxDB user interface (UI).
Tasks are exported as downloadable JSON files. Tasks are exported as downloadable JSON files.
To export a task: To export a task:

View File

@ -2,8 +2,7 @@
title: Run a task title: Run a task
seotitle: Run an InfluxDB task seotitle: Run an InfluxDB task
description: > description: >
Run a data processing task using the InfluxDB user interface or the `influx` Run a data processing task using the InfluxDB UI or the `influx` CLI.
command line interface.
menu: menu:
v2_0: v2_0:
name: Run a task name: Run a task
@ -12,15 +11,15 @@ weight: 203
--- ---
InfluxDB data processing tasks generally run in defined intervals or at a specific time, InfluxDB data processing tasks generally run in defined intervals or at a specific time,
however you can manually run a task from the InfluxDB user interface (UI) or with however, you can manually run a task from the InfluxDB user interface (UI) or the
the `influx` command line interface (CLI). `influx` command line interface (CLI).
## Run a task from the InfluxDB UI ## Run a task from the InfluxDB UI
1. Click the **Tasks** icon in the left navigation to view the lists of tasks. 1. Click the **Tasks** icon in the left navigation to view the lists of tasks.
{{< nav-icon "tasks" >}} {{< nav-icon "tasks" >}}
2. Hover over the task you would like to run and click the **{{< icon "gear" >}}** icon. 2. Hover over the task you want to run and click the **{{< icon "gear" >}}** icon.
3. Select **Run Task**. 3. Select **Run Task**.
## Run a task with the influx CLI ## Run a task with the influx CLI
@ -34,7 +33,7 @@ To run a task from the `influx` CLI, the task must have already run at least onc
# List all tasks to find the ID of the task to run # List all tasks to find the ID of the task to run
influx task find influx task find
# Use the task ID to list all the previous runs of the task # Use the task ID to list previous runs of the task
influx task run find --task-id=0000000000000000 influx task run find --task-id=0000000000000000
# Use the task ID and run ID to retry a run # Use the task ID and run ID to retry a run

View File

@ -1,8 +1,7 @@
--- ---
title: View task run history and logs title: View task run history and logs
description: > description: >
View task run histories and logs using the InfluxDB user interface or the View task run histories and logs using the InfluxDB UI or the `influx` CLI.
`influx` command line interface.
menu: menu:
v2_0: v2_0:
name: View run history name: View run history
@ -10,21 +9,20 @@ menu:
weight: 203 weight: 203
--- ---
Each time an InfluxDB task runs, it creates a "run" record in the task's run history. When an InfluxDB task runs, a "run" record is created in the task's history.
Logs associated with each run provide relevant timestamps, messages, Logs associated with each run provide relevant log messages, timestamps,
and the final state of the run attempt. and the exit status of the run attempt.
Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI) Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI)
to view task run histories and associated logs. to view task run histories and associated logs.
## View a task's run history in the InfluxDB UI ## View a task's run history in the InfluxDB UI
1. Click the **Tasks** icon in the left navigation to view the lists of tasks. 1. Click the **Tasks** icon in the left navigation to view the lists of tasks.
{{< nav-icon "tasks" >}} {{< nav-icon "tasks" >}}
2. Hover over the task you would like to run and click the **{{< icon "gear" >}}** icon. 2. Hover over the task you want to run and click the **{{< icon "gear" >}}** icon.
3. Select **View Task Runs**. 3. Select **View Task Runs**.
### View task run logs ### View task run logs

View File

@ -2,8 +2,7 @@
title: Update a task title: Update a task
seotitle: Update a task for processing data in InfluxDB seotitle: Update a task for processing data in InfluxDB
description: > description: >
Update a data processing task in InfluxDB using the InfluxDB user interface or Update a data processing task in InfluxDB using the InfluxDB UI or the `influx` CLI.
the `influx` command line interface.
menu: menu:
v2_0: v2_0:
name: Update a task name: Update a task

View File

@ -2,8 +2,7 @@
title: View tasks title: View tasks
seotitle: View created tasks that process data in InfluxDB seotitle: View created tasks that process data in InfluxDB
description: > description: >
View existing data processing tasks using the InfluxDB user interface or the View existing data processing tasks using the InfluxDB UI or the `influx` CLI.
`influx` command line interface.
menu: menu:
v2_0: v2_0:
name: View tasks name: View tasks