docs: update some struct
diff --git a/docs/GettingStarted/Environment.md b/docs/GettingStarted/Environment.md
index 8b8ac40..9606fd9 100644
--- a/docs/GettingStarted/Environment.md
+++ b/docs/GettingStarted/Environment.md
@@ -10,6 +10,7 @@
### ENABLE_SUBTASKS_BY_DEFAULT
This environment variable is used to enable or disable the execution of subtasks.
+#### How to set
The format is as follows: plugin_name1:subtask_name1:enabled_value,plugin_name2:subtask_name2:enabled_value,plugin_name3:subtask_name3:enabled_value
Guidance on locating the [plugin_name and subtask_name](https://github.com/apache/incubator-devlake/blob/release-v1.0/backend/plugins/jira/tasks/issue_changelog_collector.go#L41):
@@ -17,7 +18,6 @@
- plugin_name: Represents the plugin's name, such as 'jira' for the Jira plugin.
- subtask_name: Denotes the subtask's name, like 'collectIssueChangelogs' for the Jira plugin."
-
Example 1: Enable some subtasks that are closed by default
```shell
@@ -29,6 +29,14 @@
ENABLE_SUBTASKS_BY_DEFAULT="github_graphql:Collect Job Runs:false,github_graphql:Extract Job Runs:false,github_graphql:Convert Job Runs:false"
```
+#### How to take effect
+After setting the environment variable, restart the DevLake service to take effect.
+- For Docker Compose, run `docker-compose down` and `docker-compose up -d`.
+- For Helm, run `helm upgrade --install devlake apache/devlake`.
+
+
+
+
diff --git a/docs/Plugins/jira.md b/docs/Plugins/jira.md
index d3e694c..de60106 100644
--- a/docs/Plugins/jira.md
+++ b/docs/Plugins/jira.md
@@ -15,6 +15,10 @@
Check out the [Jira entities](/Overview/SupportedDataSources.md#data-collection-scope-by-each-plugin) collected by this plugin.
+### How to get more entities
+Environment Variables `ENABLE_SUBTASKS_BY_DEFAULT` can be set to enable or disable the execution of subtasks, so that more entities can be collected.
+Check [this doc](/GettingStarted/Environment.md#enable_subtasks_by_default) for more details.
+
## Data Refresh Policy
Check out the [data refresh policy](/Overview/SupportedDataSources.md#jira) of this plugin.
@@ -72,6 +76,3 @@
}
'
```
-
-## Enable Subtasks By Environment Variables
-Environment variables: ENABLE_SUBTASKS_BY_DEFAULT can be set to enable or disable the execution of subtasks. Check [this doc](/GettingStarted/Environment.md#enable_subtasks_by_default) for more details.
diff --git a/docs/Plugins/tapd.md b/docs/Plugins/tapd.md
index 8e33815..46e01d3 100644
--- a/docs/Plugins/tapd.md
+++ b/docs/Plugins/tapd.md
@@ -8,6 +8,11 @@
This plugin collects TAPD data through its REST APIs. TAPD is an issue-tracking tool similar to Jira.
+## Entities
+### How to get more entities
+Environment Variables `ENABLE_SUBTASKS_BY_DEFAULT` can be set to enable or disable the execution of subtasks, so that more entities can be collected.
+Check [this doc](/GettingStarted/Environment.md#enable_subtasks_by_default) for more details.
+
## Supported Versions
Advanced mode available for Tapd Cloud. Check [this doc](https://devlake.apache.org/docs/Overview/SupportedDataSources#data-sources-and-data-plugins) for more details.
@@ -26,6 +31,3 @@
- Configuring Tapd via [config-ui](/Configuration/Tapd.md).
- Configuring Tapd via Config UI's [advanced mode](/Configuration/AdvancedMode.md#6-tapd).
-## Enable Subtasks By Environment Variables
-Environment variables: ENABLE_SUBTASKS_BY_DEFAULT can be set to enable or disable the execution of subtasks. Check [this doc](/GettingStarted/Environment.md#enable_subtasks_by_default) for more details.
-
diff --git a/docs/Plugins/zentao.md b/docs/Plugins/zentao.md
index 31568a5..118d8ea 100644
--- a/docs/Plugins/zentao.md
+++ b/docs/Plugins/zentao.md
@@ -8,6 +8,11 @@
This plugin collects Zentao data through its REST APIs. [Zentao](https://github.com/easysoft/zentaopms) is an issue-tracking tool similar to Jira.
+## Entities
+### How to get more entities
+Environment Variables `ENABLE_SUBTASKS_BY_DEFAULT` can be set to enable or disable the execution of subtasks, so that more entities can be collected.
+Check [this doc](/GettingStarted/Environment.md#enable_subtasks_by_default) for more details.
+
## Supported Versions
Advanced mode vailable for Zentao OSS v18.3, Enterprise v8.2, Flagship v4.3. Check [this doc](https://devlake.apache.org/docs/Overview/SupportedDataSources#data-sources-and-data-plugins) for more details.
@@ -27,6 +32,4 @@
- Configuring Zentao via [config-ui](/Configuration/Zentao.md).
- Configuring Zentao via Config UI's [advanced mode](/Configuration/AdvancedMode.md#8-zentao).
-## Enable Subtasks By Environment Variables
-Environment variables: ENABLE_SUBTASKS_BY_DEFAULT can be set to enable or disable the execution of subtasks. Check [this doc](/GettingStarted/Environment.md#enable_subtasks_by_default) for more details.
