This is an automated email from the ASF dual-hosted git repository.
yumeng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new d0298c0be docs: manuals for skipping failed tasks (#320)
d0298c0be is described below
commit d0298c0be217f2f3fa80298b43421f3e2d705b29
Author: Louis.z <[email protected]>
AuthorDate: Tue Nov 8 20:27:33 2022 +0800
docs: manuals for skipping failed tasks (#320)
Co-authored-by: Startrekzky <[email protected]>
---
docs/UserManuals/ConfigUI/Tutorial.md | 14 ++++++++------
static/img/ConfigUI/BlueprintCreation/step4.png | Bin 150824 -> 112475 bytes
2 files changed, 8 insertions(+), 6 deletions(-)
diff --git a/docs/UserManuals/ConfigUI/Tutorial.md
b/docs/UserManuals/ConfigUI/Tutorial.md
index 5c61e930c..6d46e8c51 100644
--- a/docs/UserManuals/ConfigUI/Tutorial.md
+++ b/docs/UserManuals/ConfigUI/Tutorial.md
@@ -10,7 +10,7 @@ The Apache DevLake Config UI allows you to configure the data
you wish to collec
## Creating a Blueprint
### Introduction
-A Blueprint is the plan that covers all the work to get your raw data ready
for query and metric computaion in the dashboards. We have designed the
Blueprint to help you with data collection within only one workflow. Creating a
Blueprint consists of four steps:
+A Blueprint is a plan that covers all the work to get your raw data ready for
query and metric computation in the dashboards. We have designed the Blueprint
to help you with data collection within only one workflow. Creating a Blueprint
consists of four steps:
1. Adding Data Connections: Add new or select from existing data connections
for the data you wish to collect
2. Setting Data Scope: Select the scope of data (e.g. GitHub projects or Jira
boards) for your data connections
@@ -20,12 +20,12 @@ A Blueprint is the plan that covers all the work to get
your raw data ready for
### Step 1 - Adding Data Connections
There are two ways to add data connections to your Blueprint: adding them
during the creation of a Blueprint and adding them separately on the Data
Integrations page. There is no difference between these two ways.
-When adding data connections from the Blueprint, you can either create a new
or select from an exisitng data connections.
+When adding data connections from the Blueprint, you can either create a new
or select from existing data connections.
### Step 2 - Setting Data Scope
-After adding data connections, click on "Next Step" and you will be prompted
to select the data scope of each data connections. For instance, for a GitHub
connection, you will need to enter the projects you wish to sync and for Jira,
you will need to select the boards.
+After adding data connections, click on "Next Step" and you will be prompted
to select the data scope of each data connection. For instance, for a GitHub
connection, you will need to enter the projects you wish to sync and for Jira,
you will need to select the boards.
@@ -37,14 +37,16 @@ Currently, DevLake only supports transformation for GitHub
and Jira connections.
### Step 4 - Setting Sync Frequency
-You can choose how often you would like to sync your data in this step by
selecting a sync frequency option or enter a cron code to specify your prefered
schedule.
+You can choose how often you would like to sync your data in this step by
selecting a sync frequency option or entering a cron code to specify your
preferred schedule.
+
+Besides, you can click `Skip failed tasks` if you are going to collect a large
volume of data, eg. 10+ GitHub repositories, Jira boards, etc. This will help
you avoid losing all data when encountering a few bugs during data collection.
For clarity, a task is a unit of a pipeline, an execution of a blueprint. By
default, when a task is failed, the whole pipeline will fail and all the data
that has been collected will be discarded. By skipping failed tasks, the
pipeline will continue to ru [...]
After setting up the Blueprint, you will be prompted to the Blueprint's
activity detail page, where you can track the progress of the current run and
wait for it to finish before the dashboards become available. You can also view
all historical runs of previously created Blueprints from the list on the
Blueprint page.
## Editing a Blueprint (Normal Mode)
-On the Blueprint list page, clicking on any Blueprint will lead you to the
detail page of the blueprint. If you switch to the Settings tab on the detail
page, you can see the settings of your Blueprint and edit parts of it
seperately.
+On the Blueprint list page, clicking on any Blueprint will lead you to the
detail page of the blueprint. If you switch to the Settings tab on the detail
page, you can see the settings of your Blueprint and edit parts of it
separately.
In the current version, the Blueprint editing feature **allows** editing:
- The Blueprint's name
@@ -65,4 +67,4 @@ The Settings page for editing Blueprints:
## Creating and Managing Data Connections
-The Data Connections page allows you to view, create and manage all your data
connections at one place.
+The Data Connections page allows you to view, create and manage all your data
connections in one place.
diff --git a/static/img/ConfigUI/BlueprintCreation/step4.png
b/static/img/ConfigUI/BlueprintCreation/step4.png
index 5bee147b2..989b3f3a3 100644
Binary files a/static/img/ConfigUI/BlueprintCreation/step4.png and
b/static/img/ConfigUI/BlueprintCreation/step4.png differ
