From dcde596002b9789e09db627e2c48f8e732965e0d Mon Sep 17 00:00:00 2001
From: Asher <ash@coder.com>
Date: Mon, 20 Apr 2020 18:45:04 -0500
Subject: [PATCH] Document debugging process

Closes #1465.
---
 .github/issue_template.md     |  3 +++
 doc/FAQ.md                    | 29 +++++++++++++++++++++++++++++
 src/browser/pages/error.html  |  5 ++++-
 src/browser/pages/update.html |  5 ++++-
 4 files changed, 40 insertions(+), 2 deletions(-)

diff --git a/.github/issue_template.md b/.github/issue_template.md
index 7d73b982..09e1e5bb 100644
--- a/.github/issue_template.md
+++ b/.github/issue_template.md
@@ -2,5 +2,8 @@
 Please file all questions and support requests at https://www.reddit.com/r/codeserver/
 The issue tracker is only for bugs.
 
+Please see https://github.com/cdr/code-server/blob/master/doc/FAQ.md#how-do-i-debug-issues-with-code-server
+and include any logging information relevant to the issue.
+
 Please search for existing issues before filing.
 -->
diff --git a/doc/FAQ.md b/doc/FAQ.md
index e44f698c..6da4fdcc 100644
--- a/doc/FAQ.md
+++ b/doc/FAQ.md
@@ -142,6 +142,35 @@ code-server tries the following in order:
 3. The workspace or directory passed on the command line.
 4. The last opened workspace or directory.
 
+## How do I debug issues with code-server?
+
+First run code-server with at least `debug` logging (or `trace` to be really
+thorough) by setting the `--log` flag or the `LOG_LEVEL` environment variable.
+`-vvv` and `--verbose` are aliases for `--log trace`.
+
+```
+code-server --log debug
+```
+
+Once this is done, replicate the issue you're having then collect logging
+information from the following places:
+
+1. stdout.
+2. The most recently created directory in the `logs` directory (found in the
+   data directory; see below for how to find that).
+3. The browser console and network tabs.
+
+Additionally, collecting core dumps (you may need to enable them first) if
+code-server crashes can be helpful.
+
+### Where is the data directory?
+
+If the `XDG_DATA_HOME` environment variable is set the data directory will be
+`$XDG_DATA_HOME/code-server`. Otherwise the default is:
+
+1. Linux: `~/.local/share/code-server`.
+2. Mac: `~/Library/Application\ Support/code-server`.
+
 ## Enterprise
 
 Visit [our enterprise page](https://coder.com) for more information about our
diff --git a/src/browser/pages/error.html b/src/browser/pages/error.html
index 17f7da29..0ae7bb2b 100644
--- a/src/browser/pages/error.html
+++ b/src/browser/pages/error.html
@@ -6,7 +6,10 @@
       name="viewport"
       content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0, user-scalable=no"
     />
-    <meta http-equiv="Content-Security-Policy" content="style-src 'self'; manifest-src 'self'; img-src 'self' data:; font-src 'self' data:;" />
+    <meta
+      http-equiv="Content-Security-Policy"
+      content="style-src 'self'; manifest-src 'self'; img-src 'self' data:; font-src 'self' data:;"
+    />
     <title>{{ERROR_TITLE}} - code-server</title>
     <link rel="icon" href="{{BASE}}/static/{{COMMIT}}/src/browser/media/favicon.ico" type="image/x-icon" />
     <link
diff --git a/src/browser/pages/update.html b/src/browser/pages/update.html
index 125a95d9..e1506f0f 100644
--- a/src/browser/pages/update.html
+++ b/src/browser/pages/update.html
@@ -6,7 +6,10 @@
       name="viewport"
       content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0, user-scalable=no"
     />
-    <meta http-equiv="Content-Security-Policy" content="style-src 'self'; manifest-src 'self'; img-src 'self' data:; font-src 'self' data:;" />
+    <meta
+      http-equiv="Content-Security-Policy"
+      content="style-src 'self'; manifest-src 'self'; img-src 'self' data:; font-src 'self' data:;"
+    />
     <title>code-server</title>
     <link rel="icon" href="{{BASE}}/static/{{COMMIT}}/src/browser/media/favicon.ico" type="image/x-icon" />
     <link