🔨 chore: update issue template (lobehub#2624)

* 🔨 chore: update issue template * 🔨 chore: update issue template * 📝 docs: Add introduction to `ENABLED_OPENAI` and `ENABLED_OLLAMA`
SilvaneiMartins · May 24, 2024 · 634870a · 634870a
1 parent 73989e7
commit 634870a
Show file tree

Hide file tree

Showing 4 changed files with 78 additions and 33 deletions.
diff --git a/.github/ISSUE_TEMPLATE/1_bug_report.yml b/.github/ISSUE_TEMPLATE/1_bug_report.yml
@@ -3,10 +3,29 @@ description: 'Report an bug'
 title: '[Bug] '
 labels: ['🐛 Bug']
 body:
+  - type: dropdown
+    attributes:
+      label: '📦 Environment'
+      options:
+        - Unselected
+        - Official
+        - Official Preview
+        - Vercel / Zeabur / Sealos
+        - Docker
+        - Other
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: '📌 Version'
+    validations:
+      required: true
+
   - type: dropdown
     attributes:
       label: '💻 Operating System'
       options:
+        - Unselected
         - Windows
         - macOS
         - Ubuntu
@@ -16,21 +35,11 @@ body:
         - Other
     validations:
       required: true
-  - type: dropdown
-    attributes:
-      label: '📦 Environment'
-      options:
-        - Official Preview
-        - Vercel / Zeabur / Sealos
-        - Docker
-        - Other
-    validations:
-      required: true
-
   - type: dropdown
     attributes:
       label: '🌐 Browser'
       options:
+        - Unselected
         - Chrome
         - Edge
         - Safari
@@ -41,17 +50,17 @@ body:
   - type: textarea
     attributes:
       label: '🐛 Bug Description'
-      description: A clear and concise description of the bug.
+      description: A clear and concise description of the bug, if the above option is `Other`, please also explain in detail.
     validations:
       required: true
-  - type: textarea
-    attributes:
-      label: '🚦 Expected Behavior'
-      description: A clear and concise description of what you expected to happen.
   - type: textarea
     attributes:
       label: '📷 Recurrence Steps'
       description: A clear and concise description of how to recurrence.
+  - type: textarea
+    attributes:
+      label: '🚦 Expected Behavior'
+      description: A clear and concise description of what you expected to happen.
   - type: textarea
     attributes:
       label: '📝 Additional Information'

diff --git a/.github/ISSUE_TEMPLATE/1_bug_report_cn.yml b/.github/ISSUE_TEMPLATE/1_bug_report_cn.yml
@@ -5,33 +5,41 @@ labels: ['🐛 Bug']
 body:
   - type: dropdown
     attributes:
-      label: '💻 系统环境'
+      label: '📦 部署环境'
       options:
-        - Windows
-        - macOS
-        - Ubuntu
-        - Other Linux
-        - iOS
-        - Android
+        - 待选择
+        - Official
+        - Official Preview
+        - Vercel / Zeabur / Sealos
+        - Docker
         - Other
     validations:
       required: true
+  - type: input
+    attributes:
+      label: '📌 软件版本'
+    validations:
+      required: true
 
   - type: dropdown
     attributes:
-      label: '📦 部署环境'
+      label: '💻 系统环境'
       options:
-        - Official Preview
-        - Vercel / Zeabur / Sealos
-        - Docker
+        - 待选择
+        - Windows
+        - macOS
+        - Ubuntu
+        - Other Linux
+        - iOS
+        - Android
         - Other
     validations:
       required: true
-
   - type: dropdown
     attributes:
       label: '🌐 浏览器'
       options:
+        - 待选择
         - Chrome
         - Edge
         - Safari
@@ -42,17 +50,17 @@ body:
   - type: textarea
     attributes:
       label: '🐛 问题描述'
-      description: 请提供一个清晰且简洁的问题描述。
+      description: 请提供一个清晰且简洁的问题描述，若上述选项为`Other`，也请详细说明。
     validations:
       required: true
-  - type: textarea
-    attributes:
-      label: '🚦 期望结果'
-      description: 请提供一个清晰且简洁的描述，说明您期望发生什么。
   - type: textarea
     attributes:
       label: '📷 复现步骤'
       description: 请提供一个清晰且简洁的描述，说明如何复现问题。
+  - type: textarea
+    attributes:
+      label: '🚦 期望结果'
+      description: 请提供一个清晰且简洁的描述，说明您期望发生什么。
   - type: textarea
     attributes:
       label: '📝 补充信息'

diff --git a/docs/self-hosting/environment-variables/model-provider.mdx b/docs/self-hosting/environment-variables/model-provider.mdx
@@ -15,6 +15,13 @@ When deploying LobeChat, a rich set of environment variables related to model se
 
 ## OpenAI
 
+### `ENABLED_OPENAI`
+
+- Type：Optional
+- Description：Enables OpenAI as a model provider by default, turns off the OpenAI service when set to `0`
+- Default：`1`
+- Example：`0`
+
 ### `OPENAI_API_KEY`
 
 - Type: Required
@@ -189,6 +196,13 @@ If you need to use Azure OpenAI to provide model services, you can refer to the
 
 ## Ollama
 
+### `ENABLED_OLLAMA`
+
+- Type：Optional
+- Description：Enables Ollama as a model provider by default, turns off the Ollama service when set to `0`
+- Default：`1`
+- Example：`0`
+
 ### `OLLAMA_PROXY_URL`
 
 - Type: Required

diff --git a/docs/self-hosting/environment-variables/model-provider.zh-CN.mdx b/docs/self-hosting/environment-variables/model-provider.zh-CN.mdx
@@ -15,6 +15,13 @@ LobeChat 在部署时提供了丰富的模型服务商相关的环境变量，
 
 ## OpenAI
 
+### `ENABLED_OPENAI`
+
+- 类型：可选
+- 描述：默认启用 OpenAI 作为模型供应商，当设为 0 时关闭 OpenAI 服务
+- 默认值：`1`
+- 示例：`0`
+
 ### `OPENAI_API_KEY`
 
 - 类型：必选
@@ -187,6 +194,13 @@ LobeChat 在部署时提供了丰富的模型服务商相关的环境变量，
 
 ## Ollama
 
+### `ENABLED_OLLAMA`
+
+- 类型：可选
+- 描述：默认启用 Ollama 作为模型供应商，当设为 0 时关闭 Ollama 服务
+- 默认值：`1`
+- 示例：`0`
+
 ### `OLLAMA_PROXY_URL`
 
 - 类型：必选