You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by ab...@apache.org on 2022/07/20 06:22:02 UTC
[incubator-devlake-website] 01/02: docs: updated user manuals
This is an automated email from the ASF dual-hosted git repository.
abeizn pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
commit f6f1a73f3d4f7aceaef9abc660740d5d7c441a66
Author: yumengwang03 <yu...@merico.dev>
AuthorDate: Wed Jul 20 14:09:35 2022 +0800
docs: updated user manuals
---
docs/QuickStart/DockerComposeSetup.md | 2 +-
docs/UserManuals/AdvancedMode.md | 13 +++++++------
docs/UserManuals/GitHubUserGuide.md | 5 -----
docs/UserManuals/RecurringPipelines.md | 30 ------------------------------
static/img/AdvancedMode/AdvancedMode1.png | Bin 0 -> 83402 bytes
static/img/AdvancedMode/AdvancedMode2.png | Bin 0 -> 79648 bytes
static/img/AdvancedMode/AdvancedMode3.png | Bin 0 -> 155243 bytes
7 files changed, 8 insertions(+), 42 deletions(-)
diff --git a/docs/QuickStart/DockerComposeSetup.md b/docs/QuickStart/DockerComposeSetup.md
index 8a044317..a2973be4 100644
--- a/docs/QuickStart/DockerComposeSetup.md
+++ b/docs/QuickStart/DockerComposeSetup.md
@@ -35,7 +35,7 @@ sidebar_position: 1
- We use [Grafana](https://grafana.com/) as a visualization tool to build charts for the [data](../DataModels/DataSupport.md) stored in our database.
- Using SQL queries, we can add panels to build, save, and edit customized dashboards.
- All the details on provisioning and customizing a dashboard can be found in the [Grafana Doc](../UserManuals/GrafanaUserGuide.md).
-4. To synchronize data periodically, users can set up recurring pipelines with DevLake's [pipeline blueprint](../UserManuals/RecurringPipelines.md) for details.
+
## Upgrade to a newer version
diff --git a/docs/UserManuals/AdvancedMode.md b/docs/UserManuals/AdvancedMode.md
index 4323133a..a359f950 100644
--- a/docs/UserManuals/AdvancedMode.md
+++ b/docs/UserManuals/AdvancedMode.md
@@ -1,5 +1,5 @@
---
-title: "Advanced Mode"
+title: "Advanced Mode (WIP)"
sidebar_position: 2
description: >
Advanced Mode
@@ -18,17 +18,18 @@ Advanced mode gives the most flexibility to users by exposing the JSON API.
## How to use advanced mode to create pipelines?
-1. Visit the "Create Pipeline Run" page on `config-ui`
+1. Click on "+ New Blueprint" on the Blueprint page.
-
+
-2. Scroll to the bottom and toggle on the "Advanced Mode" button
+2. In step 1, click on the "Advanced Mode" link.
-
+
3. The pipeline editor expects a 2D array of plugins. The first dimension represents different stages of the pipeline and the second dimension describes the plugins in each stage. Stages run in sequential order and plugins within the same stage runs in parallel. We provide some templates for users to get started. Please also see the next section for some examples.
-
+
+
## Examples
diff --git a/docs/UserManuals/GitHubUserGuide.md b/docs/UserManuals/GitHubUserGuide.md
index fa674561..180b1f9d 100644
--- a/docs/UserManuals/GitHubUserGuide.md
+++ b/docs/UserManuals/GitHubUserGuide.md
@@ -29,7 +29,6 @@ There're 3 steps.
1. Configure GitHub connection
2. Create a pipeline to run GitHub plugin
3. Create a pipeline to run GitExtractor plugin
-4. [Optional] Set up a recurring pipeline to keep data fresh
### Step 1 - Configure GitHub connection
@@ -107,10 +106,6 @@ See the pipeline finishes (progress 100%):
4. See dashboards populated with GitHub data.
-### Step 4 - [Optional] Set up a recurring pipeline to keep data fresh
-
-Please see [How to create recurring pipelines](./RecurringPipelines.md) for details.
-
diff --git a/docs/UserManuals/RecurringPipelines.md b/docs/UserManuals/RecurringPipelines.md
deleted file mode 100644
index ce82b1eb..00000000
--- a/docs/UserManuals/RecurringPipelines.md
+++ /dev/null
@@ -1,30 +0,0 @@
----
-title: "Recurring Pipelines"
-sidebar_position: 3
-description: >
- Recurring Pipelines
----
-
-## How to create recurring pipelines?
-
-Once you've verified that a pipeline works, most likely you'll want to run that pipeline periodically to keep data fresh, and DevLake's pipeline blueprint feature have got you covered.
-
-
-1. Click 'Create Pipeline Run' and
- - Toggle the plugins you'd like to run, here we use GitHub and GitExtractor plugin as an example
- - Toggle on Automate Pipeline
- 
-
-
-2. Click 'Add Blueprint'. Fill in the form and 'Save Blueprint'.
-
- - **NOTE**: The schedule syntax is standard unix cron syntax, [Crontab.guru](https://crontab.guru/) is an useful reference
- - **IMPORANT**: The scheduler is running using the `UTC` timezone. If you want data collection to happen at 3 AM New York time (UTC-04:00) every day, use **Custom Shedule** and set it to `0 7 * * *`
-
- 
-
-3. Click 'Save Blueprint'.
-
-4. Click 'Pipeline Blueprints', you can view and edit the new blueprint in the blueprint list.
-
- 
\ No newline at end of file
diff --git a/static/img/AdvancedMode/AdvancedMode1.png b/static/img/AdvancedMode/AdvancedMode1.png
new file mode 100644
index 00000000..fee757b8
Binary files /dev/null and b/static/img/AdvancedMode/AdvancedMode1.png differ
diff --git a/static/img/AdvancedMode/AdvancedMode2.png b/static/img/AdvancedMode/AdvancedMode2.png
new file mode 100644
index 00000000..b32dadf8
Binary files /dev/null and b/static/img/AdvancedMode/AdvancedMode2.png differ
diff --git a/static/img/AdvancedMode/AdvancedMode3.png b/static/img/AdvancedMode/AdvancedMode3.png
new file mode 100644
index 00000000..57f67b9b
Binary files /dev/null and b/static/img/AdvancedMode/AdvancedMode3.png differ