From 928913f6b0f486dac818c560203789d939276c4e Mon Sep 17 00:00:00 2001
From: Niraj Tolia <ntolia@users.noreply.github.com>
Date: Fri, 13 Jan 2023 00:19:32 -0800
Subject: [PATCH] Update log file docs (#2141)

## Description

- Updates the log file docs to use OS tabs
- Fixes Windows forward vs. backslash in paths
- Updates the GitHub issue template

## Does this PR need a docs update or release note?

- [x] :no_entry: No

## Type of change

- [x] :bug: Bugfix
- [x] :world_map: Documentation
---
 .github/ISSUE_TEMPLATE/BUG-REPORT.yaml |  2 +-
 website/docs/setup/configuration.md    | 31 +++++++++++++++++++-------
 2 files changed, 24 insertions(+), 9 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yaml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yaml
index f9861b415..438c9f35b 100644
--- a/.github/ISSUE_TEMPLATE/BUG-REPORT.yaml
+++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yaml
@@ -35,6 +35,6 @@ body:
     id: logs
     attributes:
       label: Relevant log output
-      description: Please run Corso with `--log-level debug`.
+      description: Please run Corso with `--log-level debug` and attach the log file.
       placeholder: This will be automatically formatted, so no need for backticks.
       render: shell
diff --git a/website/docs/setup/configuration.md b/website/docs/setup/configuration.md
index cee7c7988..85c99c6bb 100644
--- a/website/docs/setup/configuration.md
+++ b/website/docs/setup/configuration.md
@@ -129,14 +129,29 @@ directory within the container.
 
 ## Log Files
 
-The location of log files varies by operating system:
+The default location of Corso's log file is shown below but the location can be overridden by using the `--log-file` flag.
+You can also use `stdout` or `stderr` as the `--log-file` location to redirect the logs to "stdout" and "stderr" respectively.
 
-* On Linux - `~/.cache/corso/logs/<timestamp>.log`
-* On macOS - `~/Library/Logs/corso/logs/<timestamp>.log`
-* On Windows - `%LocalAppData%\corso/logs/<timestamp>.log`
+<Tabs groupId="os">
+<TabItem value="win" label="Windows">
 
-Log file location can be overridden by setting the `--log-file` flag.
+  ```powershell
+  %LocalAppData%\corso\logs\<timestamp>.log
+  ```
 
-:::info
-You can use `stdout` or `stderr` as the `--log-file` location to redirect the logs to "stdout" and "stderr" respectively.
-:::
+</TabItem>
+<TabItem value="unix" label="Linux">
+
+  ```bash
+  $HOME/.cache/corso/logs/<timestamp>.log
+  ```
+
+</TabItem>
+<TabItem value="macos" label="macOS">
+
+  ```bash
+  $HOME/Library/Logs/corso/logs/<timestamp>.log
+  ```
+
+</TabItem>
+</Tabs>