Fix links in bug report template

Signed-off-by: James Bornholt <bornholt@amazon.com>
jamesbornholt · Feb 22, 2024 · 4c87164 · 4c87164
1 parent d136fb4
commit 4c87164
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -16,10 +16,8 @@ body:
       value: |
         ### Before opening a new bug report...
 
-        * Have you checked if the issue/error you are facing is mentioned in our [troubleshooting documentation](../../doc/TROUBLESHOOTING.md)?
-        * Is your workload/application depending on behavior or operations which are unsupported by Mountpoint?
-
-        Please check Mountpoint's [semantics documentation](../../doc/SEMANTICS.md) for more information.
+        * Have you checked if the issue/error you are facing is mentioned in our [troubleshooting documentation](https://github.com/awslabs/mountpoint-s3/blob/main/doc/TROUBLESHOOTING.md)?
+        * Is your workload/application depending on behavior or operations which are unsupported by Mountpoint? Please check Mountpoint's [semantics documentation](https://github.com/awslabs/mountpoint-s3/blob/main/doc/SEMANTICS.md) for more information.
   - type: input
     id: project-version
     attributes:
@@ -71,7 +69,7 @@ body:
       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.
-        Use --debug and --debug-crt CLI flags to gather more detailed logs.
+        Use the `--debug` and `--debug-crt` CLI flags to gather detailed logs. See the [logging documentation](https://github.com/awslabs/mountpoint-s3/blob/main/doc/LOGGING.md) for more details.
       render: shell
     validations:
       required: false
diff --git a/doc/TROUBLESHOOTING.md b/doc/TROUBLESHOOTING.md
@@ -9,6 +9,9 @@ For more detailed information, please refer to Mountpoint's [semantics documenta
 This document aims to capture errors from the latest versions of Mountpoint.
 If you are using an older version of Mountpoint, please refer to older versions of this document.
 
+A great first step for troubleshooting Mountpoint is to inspect its logs,
+which are emitted to `journald` by default. See the [logging documentation](LOGGING.md) for more details on how to access Mountpoint logs.
+
 ## Random writes
 
 Mountpoint supports writing to a file sequentially. Random writes, or 'out-of-order' writes, will return an error to FUSE which may appear in applications with the error message "Invalid argument".