docs: enable subtasks by environment variables

apache · Apr 28, 2024 · 2a1983d · 2a1983d
1 parent 868eedc
commit 2a1983d
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 2 deletions.
diff --git a/docs/GettingStarted/Authentication.md b/docs/GettingStarted/Authentication.md
@@ -1,6 +1,6 @@
 ---
 title: "Security and Authentication"
-sidebar_position: 8
+sidebar_position: 5
 description: How to secure your deployment and enable the Authentication
 ---
 

diff --git a/docs/GettingStarted/Environment.md b/docs/GettingStarted/Environment.md
@@ -0,0 +1,34 @@
+---
+title: "Environment Variables"
+sidebar_position: 6
+description: How to set up environment variables for DevLake
+---
+
+This document explains how to set environment variables for Apache DevLake and what environment variables can be set.
+
+## Environment Variables
+### ENABLE_SUBTASKS_BY_DEFAULT
+This environment variable is used to enable or disable the execution of subtasks.
+
+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):
+
+- 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
+ENABLE_SUBTASKS_BY_DEFAULT="jira:collectIssueChangelogs:true,jira:extractIssueChangelogs:true,jira:convertIssueChangelogs:true,tapd:collectBugChangelogs:true,tapd:extractBugChangelogs:true,tapd:convertBugChangelogs:true,zentao:collectBugRepoCommits:true,zentao:extractBugRepoCommits:true,zentao:convertBugRepoCommits:true,zentao:collectStoryRepoCommits:true,zentao:extractStoryRepoCommits:true,zentao:convertStoryRepoCommits:true,zentao:collectTaskRepoCommits:true,zentao:extractTaskRepoCommits:true,zentao:convertTaskRepoCommits:true"
+```
+
+Example 2: Close some subtasks that are executed by default
+```shell
+ENABLE_SUBTASKS_BY_DEFAULT="github_graphql:Collect Job Runs:false,github_graphql:Extract Job Runs:false,github_graphql:Convert Job Runs:false"
+```
+
+
+
+
diff --git a/docs/GettingStarted/Upgrade.md b/docs/GettingStarted/Upgrade.md
@@ -1,6 +1,6 @@
 ---
 title: "Upgrade"
-sidebar_position: 3
+sidebar_position: 4
 description: How to upgrade your Apache DevLake to a newer version
 ---
 

diff --git a/docs/Plugins/jira.md b/docs/Plugins/jira.md
@@ -72,3 +72,6 @@ curl 'http://localhost:8080/pipelines' \
 }
 '
 ```
+
+## 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
@@ -25,3 +25,7 @@ Metrics that can be calculated based on the data collected from Tapd:
 
 - 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
@@ -26,3 +26,7 @@ Metrics that can be calculated based on the data collected from Zentao:
 
 - 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.
+