fix(bug_report.md): update markdown templating

cloudnativelabs · Jul 5, 2024 · 84c3549 · 84c3549
1 parent 94b17b8
commit 84c3549
Showing 1 changed file with 22 additions and 15 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -7,34 +7,41 @@ assignees: ''
 
 ---
 
-**What happened?**
+## What happened?
+
 A clear and concise description of what the bug is.
 
-**What did you expect to happen?**
+## What did you expect to happen?
+
 A clear and concise description of what you expected to happen.
 
-**How can we reproduce the behavior you experienced?**
+## How can we reproduce the behavior you experienced?
+
 Steps to reproduce the behavior:
+
 1. Step 1
 2. Step 2
 3. Step 3
 4. Step 4
 
-**Screenshots / Architecture Diagrams / Network Topologies **
+## Screenshots / Architecture Diagrams / Network Topologies
+
 If applicable, add those here to help explain your problem.
 
-** System Information (please complete the following information):**
- - Kube-Router Version (`kube-router --version`): [e.g. 1.0.1]
- - Kube-Router Parameters: [e.g. --run-router --run-service-proxy --enable-overlay --overlay-type=full etc.]
- - Kubernetes Version (`kubectl version`) : [e.g. 1.18.3]
- - Cloud Type: [e.g. AWS, GCP, Azure, on premise]
- - Kubernetes Deployment Type: [e.g. EKS, GKE, Kops, Kubeadm, etc.]
- - Kube-Router Deployment Type: [e.g. DaemonSet, System Service]
- - Cluster Size: [e.g. 200 Nodes]
+## System Information (please complete the following information)
+
+- Kube-Router Version (`kube-router --version`): [e.g. 1.0.1]
+- Kube-Router Parameters: [e.g. --run-router --run-service-proxy --enable-overlay --overlay-type=full etc.]
+- Kubernetes Version (`kubectl version`) : [e.g. 1.18.3]
+- Cloud Type: [e.g. AWS, GCP, Azure, on premise]
+- Kubernetes Deployment Type: [e.g. EKS, GKE, Kops, Kubeadm, etc.]
+- Kube-Router Deployment Type: [e.g. DaemonSet, System Service]
+- Cluster Size: [e.g. 200 Nodes]
+
+## Logs, other output, metrics
 
-** Logs, other output, metrics **
 Please provide logs, other kind of output or observed metrics here.
 
-**Additional context**
-Add any other context about the problem here.
+## Additional context
 
+Add any other context about the problem here.