This is an automated email from the ASF dual-hosted git repository.
hez 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 3dd0fcc4 docs: added blueprint editing manual (#176)
3dd0fcc4 is described below
commit 3dd0fcc4dfee9a5a7b787d764d66129e7f8e81ed
Author: Yumeng Wang <[email protected]>
AuthorDate: Thu Aug 25 05:32:44 2022 +0800
docs: added blueprint editing manual (#176)
---
docs/UserManuals/ConfigUI/AdvancedMode.md | 6 +++++
docs/UserManuals/ConfigUI/Tutorial.md | 28 ++++++++++++++++++++-
static/img/ConfigUI/BlueprintCreation/step1.png | Bin 0 -> 179511 bytes
static/img/ConfigUI/BlueprintCreation/step2.png | Bin 0 -> 162754 bytes
static/img/ConfigUI/BlueprintCreation/step3.png | Bin 0 -> 248961 bytes
static/img/ConfigUI/BlueprintCreation/step4.png | Bin 0 -> 150824 bytes
.../ConfigUI/BlueprintEditing/blueprint-edit1.png | Bin 0 -> 184010 bytes
.../ConfigUI/BlueprintEditing/blueprint-edit2.png | Bin 0 -> 148851 bytes
8 files changed, 33 insertions(+), 1 deletion(-)
diff --git a/docs/UserManuals/ConfigUI/AdvancedMode.md
b/docs/UserManuals/ConfigUI/AdvancedMode.md
index 3bcea1bf..c0ad7d45 100644
--- a/docs/UserManuals/ConfigUI/AdvancedMode.md
+++ b/docs/UserManuals/ConfigUI/AdvancedMode.md
@@ -89,3 +89,9 @@ Below is an example for collecting a GitHub repo and a Jira
board in parallel. I
]
]
```
+## Editing a Blueprint (Advanced Mode)
+This section is for editing a Blueprint in the Advanced Mode. To edit in the
Normal mode, please refer to [this
guide](Tutorial.md#editing-a-blueprint-normal-mode).
+
+To edit a Blueprint created in the Advanced mode, you can simply go the
Settings page of that Blueprint and click on Edit JSON to edit its
configuration.
+
+
\ No newline at end of file
diff --git a/docs/UserManuals/ConfigUI/Tutorial.md
b/docs/UserManuals/ConfigUI/Tutorial.md
index f31698c9..5c61e930 100644
--- a/docs/UserManuals/ConfigUI/Tutorial.md
+++ b/docs/UserManuals/ConfigUI/Tutorial.md
@@ -22,21 +22,47 @@ There are two ways to add data connections to your
Blueprint: adding them during
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)
+
+
+## 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.
+
+In the current version, the Blueprint editing feature **allows** editing:
+- The Blueprint's name
+- The sync frequency
+- The data scope of a connection
+- The data entities of the data scope
+- The transformation rules of any data scope
+
+and does **NOT allow**:
+- Adding or deleting connections to an existing blueprint (will be available
in the future)
+- Editing any connections
+
+Please note:
+1. The connections of some data sources, such as Jenkins, do not have an
editing button, because their configuration do not contain data scope, data
entities and/or transformation.
+2. If you have created the Blueprint in the Normal mode, you will only be able
to edit it in the Normal Mode; if you have created it in the Advanced Mode,
please refer to [this guide](AdvancedMode.md#editing-a-blueprint-advanced-mode)
for editing.
+
+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.
diff --git a/static/img/ConfigUI/BlueprintCreation/step1.png
b/static/img/ConfigUI/BlueprintCreation/step1.png
new file mode 100644
index 00000000..032379d6
Binary files /dev/null and b/static/img/ConfigUI/BlueprintCreation/step1.png
differ
diff --git a/static/img/ConfigUI/BlueprintCreation/step2.png
b/static/img/ConfigUI/BlueprintCreation/step2.png
new file mode 100644
index 00000000..548df1bc
Binary files /dev/null and b/static/img/ConfigUI/BlueprintCreation/step2.png
differ
diff --git a/static/img/ConfigUI/BlueprintCreation/step3.png
b/static/img/ConfigUI/BlueprintCreation/step3.png
new file mode 100644
index 00000000..e6d40894
Binary files /dev/null and b/static/img/ConfigUI/BlueprintCreation/step3.png
differ
diff --git a/static/img/ConfigUI/BlueprintCreation/step4.png
b/static/img/ConfigUI/BlueprintCreation/step4.png
new file mode 100644
index 00000000..5bee147b
Binary files /dev/null and b/static/img/ConfigUI/BlueprintCreation/step4.png
differ
diff --git a/static/img/ConfigUI/BlueprintEditing/blueprint-edit1.png
b/static/img/ConfigUI/BlueprintEditing/blueprint-edit1.png
new file mode 100644
index 00000000..5f798987
Binary files /dev/null and
b/static/img/ConfigUI/BlueprintEditing/blueprint-edit1.png differ
diff --git a/static/img/ConfigUI/BlueprintEditing/blueprint-edit2.png
b/static/img/ConfigUI/BlueprintEditing/blueprint-edit2.png
new file mode 100644
index 00000000..126bf7b9
Binary files /dev/null and
b/static/img/ConfigUI/BlueprintEditing/blueprint-edit2.png differ
