From 0591ca1ba2cd2cf23d393bc275ea23bbc6d75f6e Mon Sep 17 00:00:00 2001 From: Niraj Tolia Date: Tue, 20 Dec 2022 11:09:19 -0800 Subject: [PATCH] Add info on getting logs to docs and the issue template (#1876) ## Description Make it clear what logs we want ## Does this PR need a docs update or release note? - [x] :white_check_mark: Yes, it's included ## Type of change - [x] :world_map: Documentation --- .github/ISSUE_TEMPLATE/BUG-REPORT.yaml | 3 ++- website/docs/support/bugs-and-features.md | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yaml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yaml index 48711f69d..f9861b415 100644 --- a/.github/ISSUE_TEMPLATE/BUG-REPORT.yaml +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yaml @@ -35,5 +35,6 @@ body: id: logs attributes: label: Relevant log output - description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + description: Please run Corso with `--log-level debug`. + placeholder: This will be automatically formatted, so no need for backticks. render: shell diff --git a/website/docs/support/bugs-and-features.md b/website/docs/support/bugs-and-features.md index 20eef8888..1e3bfff12 100644 --- a/website/docs/support/bugs-and-features.md +++ b/website/docs/support/bugs-and-features.md @@ -3,4 +3,5 @@ You can learn more about the Corso roadmap and how to interpret it [here](https://github.com/alcionai/corso-roadmap). If you run into a bug or have feature requests, please file a [GitHub issue](https://github.com/alcionai/corso/issues/) -and attach the `bug` or `enhancement` label to the issue. +and attach the `bug` or `enhancement` label to the issue. When filing bugs, please run Corso with `--log-level debug` +and add the logs to the bug report.