[incubator-devlake-website] branch main updated: docs(tapd): add tapd doc

[wa...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

warren 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 51379f325 docs(tapd): add tapd doc
51379f325 is described below

commit 51379f325cb285149f2287f51f335e816df8ae12
Author: Yingchu Chen <yi...@merico.dev>
AuthorDate: Thu Sep 15 11:36:33 2022 +0800

    docs(tapd): add tapd doc
---
 docs/Plugins/tapd.md                              |  61 +++++++++++++++++++---
 docs/UserManuals/ConfigUI/AdvancedMode.md         |   2 +-
 docs/UserManuals/ConfigUI/Tapd.md                 |  32 ++++++++++++
 static/img/ConfigUI/tapd-account.png              | Bin 0 -> 229571 bytes
 static/img/ConfigUI/tapd-add-data-connections.png | Bin 0 -> 511874 bytes
 static/img/ConfigUI/tapd-find-workspace-id.png    | Bin 0 -> 11143 bytes
 6 files changed, 88 insertions(+), 7 deletions(-)

diff --git a/docs/Plugins/tapd.md b/docs/Plugins/tapd.md
index b8db89fca..468ae8d4a 100644
--- a/docs/Plugins/tapd.md
+++ b/docs/Plugins/tapd.md
@@ -1,16 +1,65 @@
 ---
-title: "TAPD"
+title: "Tapd"
 description: >
-  TAPD Plugin
+  Tapd Plugin
 ---
 
 ## Summary
 
-This plugin collects TAPD data.
-
-This plugin is in development so you can't modify settings in config-ui.
+This plugin collects Tapd data through Tapd REST API. 
 
 ## Configuration
+Configuring Tapd via [config-ui](/UserManuals/ConfigUI/Tapd.md).
+
+## Collect Data From Tapd
+
+To collect data, select `Advanced Mode` on the `Create Blueprint` page and paste a JSON config like the following:
+
+> <font color="#ED6A45">Warning: Data collection only supports single-task execution, and the results of concurrent multi-task execution may not meet expectations.</font>
+
+```
+[
+    [
+        {
+            "plugin": "tapd",
+            "options": {
+                "workspaceId": 34***66,
+                "connectionId": 1
+            }
+        }
+    ],
+    [
+        {
+            "plugin": "tapd",
+            "options": {
+                "workspaceId": 6***14,
+                "connectionId": 1
+            }
+        }
+    ]
+]
+```
 
-In order to fully use this plugin, you will need to get endpoint/basic_auth_encoded/rate_limit and insert it into table `_tool_tapd_connections`.
+- `connectionId`: The `ID` field from **TAPD Integration** page.
+- `workspaceId`: TAPD workspace id, you can get it from two ways: 
+  - url: ![tapd-workspace-id](../../static/img/ConfigUI/tapd-find-workspace-id.png) 
+  - db: you can check workspace info from db._tool_tapd_workspaces and get all workspaceId you want to collect after execution of the following json in `advanced mode` 
+    ```json
+    [
+            [
+                    {
+                            "plugin": "tapd",
+                            "options": {
+                                    "companyId": 55850509,
+                                    "workspaceId": 1,
+                                    "connectionId": 1
+                            },
+                            "subtasks": [
+                                    "collectCompanies",
+                                    "extractCompanies"
+                            ]
+                    }
+            ]
+    ]
+    ```
 
diff --git a/docs/UserManuals/ConfigUI/AdvancedMode.md b/docs/UserManuals/ConfigUI/AdvancedMode.md
index 7d174a3f2..7f984ed5c 100644
--- a/docs/UserManuals/ConfigUI/AdvancedMode.md
+++ b/docs/UserManuals/ConfigUI/AdvancedMode.md
@@ -1,6 +1,6 @@
 ---
 title: "Using Advanced Mode"
-sidebar_position: 6
+sidebar_position: 7
 description: >
   Using the advanced mode of Config-UI
 ---
diff --git a/docs/UserManuals/ConfigUI/Tapd.md b/docs/UserManuals/ConfigUI/Tapd.md
new file mode 100644
index 000000000..d54e08f21
--- /dev/null
+++ b/docs/UserManuals/ConfigUI/Tapd.md
@@ -0,0 +1,32 @@
+---
+title: "Configuring Tapd"
+sidebar_position: 6
+description: Config UI instruction for Tapd
+---
+
+Visit config-ui: `http://localhost:4000`.
+### Step 1 - Add Data Connections
+![tapd-add-data-connections](../../../static/img/ConfigUI/tapd-add-data-connections.png)
+
+#### Connection Name
+Name your connection.
+
+#### Endpoint URL
+This should be a valid REST API endpoint
+   - `https://api.tapd.cn/`
+The endpoint url should end with `/`.
+
+#### Username / Password
+Input the username and password of your Tapd account, you can follow the steps as below.
+![tapd-account](../../../static/img/ConfigUI/tapd-account.png)
+
+#### Proxy URL (Optional)
+If you are behind a corporate firewall or VPN you may need to utilize a proxy server. Enter a valid proxy server address on your network, e.g. `http://your-proxy-server.com:1080`
+
+#### Ralte Limit (Optional)
+For tapd, we suggest you to set rate limit to 3500
+
+#### Test and Save Connection
+Click `Test Connection`, if the connection is successful, click `Save Connection` to add the connection.
+
+###
\ No newline at end of file
diff --git a/static/img/ConfigUI/tapd-account.png b/static/img/ConfigUI/tapd-account.png
new file mode 100644
index 000000000..2ec58362d
Binary files /dev/null and b/static/img/ConfigUI/tapd-account.png differ
diff --git a/static/img/ConfigUI/tapd-add-data-connections.png b/static/img/ConfigUI/tapd-add-data-connections.png
new file mode 100644
index 000000000..33e1b8550
Binary files /dev/null and b/static/img/ConfigUI/tapd-add-data-connections.png differ
diff --git a/static/img/ConfigUI/tapd-find-workspace-id.png b/static/img/ConfigUI/tapd-find-workspace-id.png
new file mode 100644
index 000000000..9087b81ad
Binary files /dev/null and b/static/img/ConfigUI/tapd-find-workspace-id.png differ