Skip to content

Commit

Permalink
docs: change advanced-guides (#197)
Browse files Browse the repository at this point in the history
Signed-off-by: zhaoxinxin <[email protected]>
  • Loading branch information
Liam-Zhao authored Dec 27, 2024
1 parent 081e506 commit b1515a2
Show file tree
Hide file tree
Showing 51 changed files with 106 additions and 26 deletions.
2 changes: 1 addition & 1 deletion docs/advanced-guides/web-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ Console page:
- [Cluster](./web-console/cluster.md)
- [Personal Access Tokens](./web-console/developer/personal-access-tokens.md)
- [Preheat](./web-console/job/preheat.md)
- [Peer](./web-console/insight/peer.md)
- [Task](./web-console/job/task.md)
- [User](./web-console/user.md)
38 changes: 36 additions & 2 deletions docs/advanced-guides/web-console/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ download from the peer until the it has the free load.
the filter parent limit and evaluate the optimal parents in selecting parents for the peer to download task.
The number of optimal parent is the scheduling parent limit.

**Job Rate Limit(requests per seconds)**: The rate limit(requests per second) for job Open API, default value is 10.

## Update Cluster

Update cluster information.
Expand All @@ -86,6 +88,12 @@ Delete cluster and at the same time delete scheduler cluster and seed peer clust

![delete-cluster](../../resource/advanced-guides/web-console/cluster/delete-cluster.png)

## Schedulers

Display the schedulers.

![schedulers](../../resource/advanced-guides/web-console/cluster/schedulers.png)

## Scheduler

Display the scheduler details.
Expand All @@ -98,6 +106,12 @@ Delete scheduler record in database.

![delete-scheduler](../../resource/advanced-guides/web-console/cluster/delete-scheduler.png)

## Delete all inative instances {#delete-all-inative-scheduler-instances}

Delete inactive schedulers record in database.

![delete-scheduler-inative-instances](../../resource/advanced-guides/web-console/cluster/delete-inactive-scheduler.png)

## Seed Peer

Display the seed peer details.
Expand All @@ -112,6 +126,26 @@ Delete seed peer record in database.

## Delete all inative instances

Delete inactive schedulers and inactive seed peers record in database.
Delete inactive seed peers record in database.

![delete-all-inative-instances](../../resource/advanced-guides/web-console/cluster/delete-inactive-seed-peer.png)

## Peers

Display the peer information, You can click the `?` button to display prompt information.

> Note: peer data is T+1.
![peers](../../resource/advanced-guides/web-console/cluster/peers.png)

## Refresh Peer Date

Force refresh of peer data.

![refresh-peer](../../resource/advanced-guides/web-console/cluster/refresh-peer.png)

## Export Peer Date

Export the peer data.

![delete-all-inative-instances](../../resource/advanced-guides/web-console/cluster/delete-all-inative-instances.png)
![export-peer](../../resource/advanced-guides/web-console/cluster/export-peer.png)
11 changes: 8 additions & 3 deletions docs/advanced-guides/web-console/job/preheat.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: preheat
title: Preheat
slug: /advanced-guides/web-console/developer/preheat/
slug: /advanced-guides/web-console/job/preheat/
---

In this article, you will be shown Preheat page information.
Expand Down Expand Up @@ -46,8 +46,13 @@ Preheat the cluster.

Args used to pass additional configuration options to the preheat task.

**Piece Length**: Piece Length can specify the size of the piece to be downloaded during preheat.
The default minimum value is 4MiB and the maximum value is 1024MiB.
**Scope**: Select the scope of preheat as needed.

- **Single Seed Peer**: Preheat to a seed peer.

- **All Seed Peers**: Preheat to each seed peer in the P2P cluster.

- **All Peers**: Preheat to each peer in the P2P cluster.

**URL**: URL address used to specify the resource to be preheat.

Expand Down
61 changes: 61 additions & 0 deletions docs/advanced-guides/web-console/job/task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
id: task
title: Task
slug: /advanced-guides/web-console/job/task/
---

In this article, you will be shown Task page information.

## 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)

### Delete successfully

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)

### Delete 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.
Binary file modified docs/resource/advanced-guides/personal-access-tokens/tokens.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.
Binary file modified docs/resource/advanced-guides/preheat/create-preheat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/resource/advanced-guides/preheat/failure-preheat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/resource/advanced-guides/preheat/pending-preheat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/resource/advanced-guides/preheat/preheats.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/resource/advanced-guides/preheat/success-preheat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/resource/advanced-guides/task/delete-task.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/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.
Binary file modified docs/resource/advanced-guides/task/executions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/resource/advanced-guides/task/failure-task.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/resource/advanced-guides/task/pending-task.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/resource/advanced-guides/task/search-task-by-task-id.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/resource/advanced-guides/task/search-task-by-url.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/resource/advanced-guides/task/success-task.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/resource/advanced-guides/web-console/cluster/cluster.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/resource/advanced-guides/web-console/cluster/clusters.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.
Binary file not shown.
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.
Binary file modified docs/resource/advanced-guides/web-console/cluster/scheduler.png
Binary file modified docs/resource/advanced-guides/web-console/cluster/seed-peer.png
Binary file modified docs/resource/advanced-guides/web-console/user/profile.png
Binary file modified docs/resource/advanced-guides/web-console/user/user.png
Binary file modified docs/resource/advanced-guides/web-console/user/users.png
10 changes: 0 additions & 10 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -190,16 +190,6 @@ module.exports = {
},
],
},
{
type: 'category',
label: 'Insight',
items: [
{
type: 'autogenerated',
dirName: 'advanced-guides/web-console/insight',
},
],
},
'advanced-guides/web-console/user',
],
},
Expand Down
10 changes: 0 additions & 10 deletions sidebars/docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -180,16 +180,6 @@ module.exports = {
},
],
},
{
type: 'category',
label: 'Insight',
items: [
{
type: 'autogenerated',
dirName: 'advanced-guides/web-console/insight',
},
],
},
'advanced-guides/web-console/user',
],
},
Expand Down

0 comments on commit b1515a2

Please sign in to comment.