Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add task documen #182

Merged
merged 5 commits into from
Nov 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions docs/advanced-guides/task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
id: task-manager
title: Task Manager
slug: /advanced-guides/task-manager/
---

This document will help you experience how to use the console to find and clear the P2P task cache.

## Search task

### Search by URL

**URL**: Query the task cache based on the URL.

**Tag**: When the task URL is the same but the tags are different,
they will be distinguished based on the tags, and the queried tasks will also be different.

**Application**: Caller application which is used for statistics and access control.

**Filter Query Params**: Filter the query parameters of the downloaded URL.
If the download URL is the same, it will be scheduled as the same task.

![search-task-by-url](../resource/advanced-guides/task/search-task-by-url.png)

### Search by task id

**Task ID**: Query the task cache based on the task id.

![search-task-by-task-id](../resource/advanced-guides/task/search-task-by-task-id.png)

## Delete task

Click `DELETE` and delete task.

![delete-task](../resource/advanced-guides/task/delete-task.png)

The deleted task will not return results immediately and you need to wait.

![pending-task](../resource/advanced-guides/task/pending-task.png)

## Executions

Displays all deleted task.

![executions](../resource/advanced-guides/task/executions.png)

### Deletion Successful

If the status is SUCCESS and the Failure list does not exist, it means that the deletion task is successful.

![success-task](../resource/advanced-guides/task/success-task.png)

### Deletion Failed

The Failure list will show the tasks that failed to execute.

![failure-task](../resource/advanced-guides/task/failure-task.png)

Click the `Description` icon to view the failure log.

![error-log](../resource/advanced-guides/task/error-log.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,7 @@ module.exports = {
],
},
'advanced-guides/preheat',
'advanced-guides/task-manager',
'advanced-guides/personal-access-tokens',
],
},
Expand Down
1 change: 1 addition & 0 deletions sidebars/docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,7 @@ module.exports = {
],
},
'advanced-guides/preheat',
'advanced-guides/task-manager',
'advanced-guides/personal-access-tokens',
],
},
Expand Down