github: update issue template placeholders

Signed-off-by: Vladimir Varankin <[email protected]>
grafana · Dec 19, 2024 · 005fa55 · 005fa55
1 parent fbfa8e9
commit 005fa55
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/.github/ISSUE_TEMPLATE/2-bug-report.yml b/.github/ISSUE_TEMPLATE/2-bug-report.yml
@@ -31,14 +31,16 @@ body:
   id: environment
   attributes:
     label: What was your environment?
-    placeholder: Infrastructure (e.g., Kubernetes, bare-metal, laptop), deployment tool (e.g., helm, jsonnet)
+    description: When sharing the configs, make sure you have redacted any credentials or other sensitive details.
+    placeholder: Infrastructure (e.g., Kubernetes, bare-metal, laptop), deployment tool (e.g., helm, jsonnet), versions (e.g. Mimir 2.14, Kubernetes 1.30, Helm 3.16).
   validations:
     required: true
 
 - type: textarea
   id: context
   attributes:
     label: Any additional context to share?
-    placeholder: Add any other context or screenshots about the feature request here.
+    description: If possible, provide the logs that illustrate what the system was doing at the time when the bug occurred.
+    placeholder: Add any other context or screenshots about the bug report here.
   validations:
     required: false
diff --git a/.github/ISSUE_TEMPLATE/3-documentation-request.yml b/.github/ISSUE_TEMPLATE/3-documentation-request.yml
@@ -32,7 +32,8 @@ body:
   id: environment
   attributes:
     label: What was your environment?
-    placeholder: Infrastructure (e.g., Kubernetes, bare-metal, laptop), deployment tool (e.g., helm, jsonnet)
+    description: When sharing the configs, make sure you have redacted any credentials or other sensitive details.
+    placeholder: Infrastructure (e.g., Kubernetes, bare-metal, laptop), deployment tool (e.g., helm, jsonnet), versions (e.g. Mimir 2.14, Kubernetes 1.30, Helm 3.16).
   validations:
     required: true