This is an automated email from the ASF dual-hosted git repository.
zky 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 4fc208bd docs: added config UI manual
4fc208bd is described below
commit 4fc208bdf3ad09094074780d9b41223812840258
Author: yumengwang03 <[email protected]>
AuthorDate: Thu Jul 21 22:34:17 2022 +0800
docs: added config UI manual
---
docs/UserManuals/AdvancedMode.md | 2 +-
docs/UserManuals/ConfigUI.md | 42 +++++++++++++++++++++++++++++++++++
docs/UserManuals/GitHubUserGuide.md | 2 +-
docs/UserManuals/GrafanaUserGuide.md | 2 +-
docs/UserManuals/TeamConfiguration.md | 2 +-
docs/UserManuals/TemporalSetup.md | 2 +-
6 files changed, 47 insertions(+), 5 deletions(-)
diff --git a/docs/UserManuals/AdvancedMode.md b/docs/UserManuals/AdvancedMode.md
index c0b5f2ff..fc41603f 100644
--- a/docs/UserManuals/AdvancedMode.md
+++ b/docs/UserManuals/AdvancedMode.md
@@ -1,6 +1,6 @@
---
title: "Advanced Mode (WIP)"
-sidebar_position: 2
+sidebar_position: 3
description: >
Advanced Mode
---
diff --git a/docs/UserManuals/ConfigUI.md b/docs/UserManuals/ConfigUI.md
new file mode 100644
index 00000000..302a7734
--- /dev/null
+++ b/docs/UserManuals/ConfigUI.md
@@ -0,0 +1,42 @@
+---
+title: "Config UI"
+sidebar_position: 1
+description: Config UI instruction
+---
+
+## Overview
+The DevLake Config UI allows you to configure the data you wish to collect
through a graphical user interface.
+
+## 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:
+
+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
+3. Adding Transformation (Optional): Add transformation rules for the data
scope you have selected in order to view corresponding metrics
+4. Setting Sync Frequency: Set up a schedule for how often you wish your data
to be synced
+
+### 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.
+
+### 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.
+
+### Step 3 - Adding Transformation (Optional)
+This step is only required for viewing certain metrics in the pre-built
dashboards that require data transformation. Without adding transformation
rules, you can still view the basic metrics.
+
+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.
+
+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 (Coming in v0.13)
+
+## Creating and Managing Data Connections
+The Data Connections page allows you to view, create and manage all your data
connections at one place.
diff --git a/docs/UserManuals/GitHubUserGuide.md
b/docs/UserManuals/GitHubUserGuide.md
index 180b1f9d..e58fb967 100644
--- a/docs/UserManuals/GitHubUserGuide.md
+++ b/docs/UserManuals/GitHubUserGuide.md
@@ -1,6 +1,6 @@
---
title: "GitHub User Guide"
-sidebar_position: 4
+sidebar_position: 5
description: >
GitHub User Guide
---
diff --git a/docs/UserManuals/GrafanaUserGuide.md
b/docs/UserManuals/GrafanaUserGuide.md
index e4757022..41a8e37f 100644
--- a/docs/UserManuals/GrafanaUserGuide.md
+++ b/docs/UserManuals/GrafanaUserGuide.md
@@ -1,6 +1,6 @@
---
title: "Grafana User Guide"
-sidebar_position: 1
+sidebar_position: 2
description: >
Grafana User Guide
---
diff --git a/docs/UserManuals/TeamConfiguration.md
b/docs/UserManuals/TeamConfiguration.md
index 4d18f523..d85f96bd 100644
--- a/docs/UserManuals/TeamConfiguration.md
+++ b/docs/UserManuals/TeamConfiguration.md
@@ -1,6 +1,6 @@
---
title: "Team Configuration"
-sidebar_position: 6
+sidebar_position: 7
description: >
Team Configuration
---
diff --git a/docs/UserManuals/TemporalSetup.md
b/docs/UserManuals/TemporalSetup.md
index f893a830..5a717dec 100644
--- a/docs/UserManuals/TemporalSetup.md
+++ b/docs/UserManuals/TemporalSetup.md
@@ -1,6 +1,6 @@
---
title: "Temporal Setup"
-sidebar_position: 5
+sidebar_position: 6
description: >
The steps to install DevLake in Temporal mode.
---
