Add: logs documentation

advplyr · May 6, 2024 · 7f12c71 · 7f12c71
1 parent f62d107
commit 7f12c71
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/client/pages/config/log.vue b/client/pages/config/log.vue
@@ -1,6 +1,14 @@
 <template>
   <div>
-    <app-settings-content :header-text="$strings.HeaderLogs">
+    <app-settings-content :header-text="$strings.HeaderLogs" :description="$strings.MessageLogsDescription">
+      <template #header-items>
+        <ui-tooltip :text="$strings.LabelClickForMoreInfo" class="inline-flex ml-2">
+          <a href="https://www.audiobookshelf.org/guides/server_logs" target="_blank" class="inline-flex">
+            <span class="material-icons text-xl w-5 text-gray-200">help_outline</span>
+          </a>
+        </ui-tooltip>
+      </template>
+
       <div class="flex justify-between mb-2 place-items-end">
         <ui-text-input ref="input" v-model="search" placeholder="Search filter.." @input="inputUpdate" clearable class="w-full sm:w-40 h-8 text-sm sm:mb-0" />
 
@@ -183,4 +191,4 @@ export default {
 .logmessage {
   width: calc(100% - 208px);
 }
-</style>
+</style>
diff --git a/client/strings/en-us.json b/client/strings/en-us.json
@@ -631,6 +631,7 @@
   "MessageListeningSessionsInTheLastYear": "{0} listening sessions in the last year",
   "MessageLoading": "Loading...",
   "MessageLoadingFolders": "Loading folders...",
+  "MessageLogsDescription": "Logs are stored in <code>/metadata/logs</code> as JSON files. Crash logs are stored in <code>/metadata/logs/crash_logs.txt</code>.",
   "MessageM4BFailed": "M4B Failed!",
   "MessageM4BFinished": "M4B Finished!",
   "MessageMapChapterTitles": "Map chapter titles to your existing audiobook chapters without adjusting timestamps",