feat(metrics): add documentation for using grafana dashboard

apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Metrics.html

@@ -80,3 +80,23 @@ trilium_notes_total 1234 1701432000
   <li><code>401</code> - Missing or invalid ETAPI token</li>
   <li><code>500</code> - Internal server error</li>
 </ul>
+<p>&nbsp;</p>
+<h2><strong>Grafana Dashboard</strong></h2>
+<figure class="image">
+  <img style="aspect-ratio:2594/1568;" src="1_Metrics_image.png" width="2594"
+  height="1568">
+</figure>
+<p>&nbsp;</p>
+<p>You can also use the Grafana Dashboard that has been created for TriliumNext
+  - just take the JSON from&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/uYF7pmepw27K/_help_bOP3TB56fL1V">grafana-dashboard.json</a>&nbsp;and
+  then import the dashboard, following these screenshots:</p>
+<figure class="image">
+  <img style="aspect-ratio:1881/282;" src="2_Metrics_image.png" width="1881"
+  height="282">
+</figure>
+<p>Then paste the JSON, and hit load:</p>
+<figure class="image">
+  <img style="aspect-ratio:1055/830;" src="Metrics_image.png" width="1055"
+  height="830">
+</figure>
+<p>&nbsp;</p>

apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Keyboard Shortcuts.html

@@ -77,7 +77,7 @@
     class="reference-link" href="#root/_help_QrtTYPmdd1qq">Markdown-like formatting</a>.</p>
 </aside>
 <ul>
-  <li>&nbsp;<kbd>Enter</kbd> in tree pane switches from tree pane into note title.
+  <li><kbd>Enter</kbd> in tree pane switches from tree pane into note title.
     Enter from note title switches focus to text editor. <kbd>Ctrl</kbd>+<kbd>.</kbd> switches
     back from editor to tree pane.</li>
   <li><kbd>Ctrl</kbd>+<kbd>.</kbd> - jump away from the editor to tree pane and

apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Geo Map.html

@@ -39,6 +39,7 @@
     </tbody>
   </table>
 </figure>
+
 <h2>Repositioning the map</h2>
 <ul>
   <li>Click and drag the map in order to move across the map.</li>
@@ -102,12 +103,11 @@
     </tbody>
   </table>
 </figure>
+
 <h2>How the location of the markers is stored</h2>
 <p>The location of a marker is stored in the <code>#geolocation</code> attribute
   of the child notes:</p>
-<p>
+<img src="18_Geo Map_image.png" width="1288" height="278">
-  <img src="18_Geo Map_image.png" width="1288" height="278">
-</p>
 <p>This value can be added manually if needed. The value of the attribute
   is made up of the latitude and longitude separated by a comma.</p>
 <h2>Repositioning markers</h2>
@@ -210,6 +210,7 @@
     </tbody>
   </table>
 </figure>
+
 <h3>Adding from OpenStreetMap</h3>
 <p>Similarly to the Google Maps approach:</p>
 <figure class="table" style="width:100%;">
@@ -259,6 +260,7 @@
     </tbody>
   </table>
 </figure>
+
 <h2>Adding GPS tracks (.gpx)</h2>
 <p>Trilium has basic support for displaying GPS tracks on the geo map.</p>
 <figure
@@ -327,7 +329,8 @@ class="table" style="width:100%;">
     <img style="aspect-ratio:678/499;" src="14_Geo Map_image.png" width="678"
     height="499">
   </figure>
-  <h3>Grid-like artifacts on the map</h3>
+  
+<h3>Grid-like artifacts on the map</h3>
   <p>This occurs if the application is not at 100% zoom which causes the pixels
     of the map to not render correctly due to fractional scaling. The only
     possible solution is to set the UI zoom at 100% (default keyboard shortcut

apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Keyboard shortcuts.html

@@ -60,7 +60,7 @@
         </td>
       </tr>
       <tr>
-        <td>Mark selected text as <a href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_UYuUB1ZekNQU">keyboard shortcut</a>
+        <td>Mark selected text as <a href="#root/_help_UYuUB1ZekNQU">keyboard shortcut</a>
         </td>
         <td><kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>K</kbd>
         </td>
@@ -68,7 +68,7 @@
         </td>
       </tr>
       <tr>
-        <td>Insert&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_YfYAtQBcfo5V">Math Equations</a>
+        <td>Insert&nbsp;<a class="reference-link" href="#root/_help_YfYAtQBcfo5V">Math Equations</a>
         </td>
         <td><kbd>Ctrl</kbd> + <kbd>M</kbd>
         </td>
@@ -76,7 +76,7 @@
         </td>
       </tr>
       <tr>
-        <td rowspan="2">Move blocks (lists, paragraphs, etc.) up</td>
+        <td>Move blocks (lists, paragraphs, etc.) up</td>
         <td><kbd>Ctrl</kbd>+<kbd>↑</kbd>&nbsp;</td>
         <td><kbd>⌘</kbd>+<kbd>↑</kbd>&nbsp;</td>
       </tr>
@@ -87,7 +87,7 @@
         </td>
       </tr>
       <tr>
-        <td rowspan="2">Move blocks (lists, paragraphs, etc.) down</td>
+        <td>Move blocks (lists, paragraphs, etc.) down</td>
         <td><kbd>Ctrl</kbd>+<kbd>↑</kbd>
         </td>
         <td><kbd>⌘</kbd>+<kbd>↑</kbd>
@@ -102,6 +102,7 @@
     </tbody>
   </table>
 </figure>
+
 <h2>Common shortcuts</h2>
 <aside class="admonition tip">
   <p>This section of keyboard shortcuts presents a subset of the keyboard shortcuts
@@ -260,6 +261,7 @@
     </tbody>
   </table>
 </figure>
+
 <h3>Interacting with blocks</h3>
 <p>Blocks are images, tables, blockquotes, annotations.</p>
 <figure class="table">
@@ -373,6 +375,7 @@
     </tbody>
   </table>
 </figure>
+
 <h3>General UI shortcuts</h3>
 <figure class="table">
   <table>

docs/User Guide/!!!meta.json

@@ -4086,12 +4086,33 @@
                                     "isInheritable": false,
                                     "position": 30
                                 },
+                                {
+                                    "type": "relation",
+                                    "name": "internalLink",
+                                    "value": "iPIMuisry3hd",
+                                    "isInheritable": false,
+                                    "position": 40
+                                },
+                                {
+                                    "type": "relation",
+                                    "name": "internalLink",
+                                    "value": "oiVPnW8QfnvS",
+                                    "isInheritable": false,
+                                    "position": 50
+                                },
+                                {
+                                    "type": "relation",
+                                    "name": "internalLink",
+                                    "value": "QrtTYPmdd1qq",
+                                    "isInheritable": false,
+                                    "position": 60
+                                },
                                 {
                                     "type": "relation",
                                     "name": "internalLink",
                                     "value": "eIg8jdvaoNNd",
                                     "isInheritable": false,
-                                    "position": 80
+                                    "position": 70
                                 },
                                 {
                                     "type": "label",
@@ -4106,27 +4127,6 @@
                                     "value": "bx bxs-keyboard",
                                     "isInheritable": false,
                                     "position": 80
-                                },
-                                {
-                                    "type": "relation",
-                                    "name": "internalLink",
-                                    "value": "iPIMuisry3hd",
-                                    "isInheritable": false,
-                                    "position": 90
-                                },
-                                {
-                                    "type": "relation",
-                                    "name": "internalLink",
-                                    "value": "oiVPnW8QfnvS",
-                                    "isInheritable": false,
-                                    "position": 100
-                                },
-                                {
-                                    "type": "relation",
-                                    "name": "internalLink",
-                                    "value": "QrtTYPmdd1qq",
-                                    "isInheritable": false,
-                                    "position": 110
                                 }
                             ],
                             "format": "markdown",
@@ -6121,39 +6121,39 @@
                                     "mime": "text/html",
                                     "attributes": [
                                         {
-                                            "type": "label",
+                                            "type": "relation",
-                                            "name": "iconClass",
+                                            "name": "internalLink",
-                                            "value": "bx bxs-keyboard",
+                                            "value": "UYuUB1ZekNQU",
                                             "isInheritable": false,
-                                            "position": 30
+                                            "position": 10
                                         },
                                         {
                                             "type": "relation",
                                             "name": "internalLink",
                                             "value": "MI26XDLSAlCD",
                                             "isInheritable": false,
-                                            "position": 40
+                                            "position": 20
                                         },
                                         {
                                             "type": "relation",
                                             "name": "internalLink",
                                             "value": "QEAPj01N5f7w",
                                             "isInheritable": false,
-                                            "position": 50
+                                            "position": 30
-                                        },
-                                        {
-                                            "type": "relation",
-                                            "name": "internalLink",
-                                            "value": "UYuUB1ZekNQU",
-                                            "isInheritable": false,
-                                            "position": 60
                                         },
                                         {
                                             "type": "relation",
                                             "name": "internalLink",
                                             "value": "YfYAtQBcfo5V",
                                             "isInheritable": false,
-                                            "position": 70
+                                            "position": 40
+                                        },
+                                        {
+                                            "type": "label",
+                                            "name": "iconClass",
+                                            "value": "bx bxs-keyboard",
+                                            "isInheritable": false,
+                                            "position": 30
                                         }
                                     ],
                                     "format": "markdown",
@@ -10727,11 +10727,65 @@
                                     "value": "bx bxs-data",
                                     "isInheritable": false,
                                     "position": 10
+                                },
+                                {
+                                    "type": "relation",
+                                    "name": "internalLink",
+                                    "value": "bOP3TB56fL1V",
+                                    "isInheritable": false,
+                                    "position": 20
                                 }
                             ],
                             "format": "markdown",
                             "dataFileName": "Metrics.md",
-                            "attachments": []
+                            "attachments": [
+                                {
+                                    "attachmentId": "6FcnvEg39b88",
+                                    "title": "image.png",
+                                    "role": "image",
+                                    "mime": "image/png",
+                                    "position": 10,
+                                    "dataFileName": "Metrics_image.png"
+                                },
+                                {
+                                    "attachmentId": "amOIi8fzVhSM",
+                                    "title": "image.png",
+                                    "role": "image",
+                                    "mime": "image/png",
+                                    "position": 10,
+                                    "dataFileName": "1_Metrics_image.png"
+                                },
+                                {
+                                    "attachmentId": "Ojj9cAXPbxJO",
+                                    "title": "image.png",
+                                    "role": "image",
+                                    "mime": "image/png",
+                                    "position": 10,
+                                    "dataFileName": "2_Metrics_image.png"
+                                }
+                            ],
+                            "dirFileName": "Metrics",
+                            "children": [
+                                {
+                                    "isClone": false,
+                                    "noteId": "bOP3TB56fL1V",
+                                    "notePath": [
+                                        "pOsGYCXsbNQG",
+                                        "tC7s2alapj8V",
+                                        "uYF7pmepw27K",
+                                        "bOP3TB56fL1V"
+                                    ],
+                                    "title": "grafana-dashboard.json",
+                                    "notePosition": 10,
+                                    "prefix": null,
+                                    "isExpanded": false,
+                                    "type": "code",
+                                    "mime": "application/json",
+                                    "attributes": [],
+                                    "dataFileName": "grafana-dashboard.json",
+                                    "attachments": []
+                                }
+                            ]
                         }
                     ]
                 },

docs/User Guide/User Guide/Advanced Usage/Metrics.md

@@ -106,3 +106,15 @@ scrape_configs:
 *   `400` - Invalid format parameter
 *   `401` - Missing or invalid ETAPI token
 *   `500` - Internal server error
+
+## **Grafana Dashboard**
+
+<figure class="image"><img style="aspect-ratio:2594/1568;" src="1_Metrics_image.png" width="2594" height="1568"></figure>
+
+You can also use the Grafana Dashboard that has been created for TriliumNext - just take the JSON from <a class="reference-link" href="Metrics/grafana-dashboard.json">grafana-dashboard.json</a> and then import the dashboard, following these screenshots:
+
+<figure class="image"><img style="aspect-ratio:1881/282;" src="2_Metrics_image.png" width="1881" height="282"></figure>
+
+Then paste the JSON, and hit load:
+
+<figure class="image"><img style="aspect-ratio:1055/830;" src="Metrics_image.png" width="1055" height="830"></figure>

docs/User Guide/User Guide/Note Types/Text/Keyboard shortcuts.md

@@ -1,7 +1,7 @@
 # Keyboard shortcuts
 ## Trilium-specific shortcuts
 
-<figure class="table"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Bring up inline formatting toolbar (arrow keys <kbd><span>←</span></kbd>,<kbd><span>→</span></kbd> to navigate, <kbd>Enter</kbd> to apply)</td><td><kbd>Alt</kbd>+<kbd>F10</kbd></td><td><kbd>⌥</kbd>+<kbd>F10</kbd></td></tr><tr><td>Bring up block formatting toolbar</td><td><kbd>Alt</kbd>+<kbd>F10</kbd></td><td><kbd>⌥</kbd>+<kbd>F10</kbd></td></tr><tr><td>Create <a href="Links.md">external link</a></td><td><kbd>Ctrl</kbd>+<kbd>K</kbd></td><td><kbd>⌘</kbd>+<kbd>K</kbd></td></tr><tr><td>Create <a href="Links.md">internal (note) link</a></td><td><kbd>Ctrl</kbd>+<kbd>L</kbd></td><td><kbd>⌘</kbd>+<kbd>L</kbd></td></tr><tr><td>Inserts current date and time at caret position</td><td><kbd>Alt</kbd>+<kbd>T</kbd>&nbsp;</td><td><kbd>⌥</kbd>+<kbd>T</kbd>&nbsp;</td></tr><tr><td>Increase paragraph indentation</td><td><kbd>Tab</kbd></td><td><kbd>⇥</kbd></td></tr><tr><td>Decrease paragraph indentation</td><td><kbd>Shift</kbd> + <kbd>Tab</kbd></td><td><kbd>⇧</kbd> + <kbd>⇥</kbd></td></tr><tr><td>Mark selected text as <a href="Developer-specific%20formatting.md">keyboard shortcut</a></td><td><kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>K</kbd></td><td><kbd>⌘</kbd>+ <kbd>⌥</kbd>+ <kbd>K</kbd></td></tr><tr><td>Insert&nbsp;<a class="reference-link" href="Math%20Equations.md">Math Equations</a></td><td><kbd>Ctrl</kbd> + <kbd>M</kbd></td><td><kbd>⌘</kbd>+ <kbd>M</kbd></td></tr><tr><td rowspan="2">Move blocks (lists, paragraphs, etc.) up</td><td><kbd>Ctrl</kbd>+<kbd>↑</kbd>&nbsp;</td><td><kbd>⌘</kbd>+<kbd>↑</kbd>&nbsp;</td></tr><tr><td><kbd>Alt</kbd>+<kbd>↑</kbd></td><td><kbd>⌥</kbd>+<kbd>↑</kbd></td></tr><tr><td rowspan="2">Move blocks (lists, paragraphs, etc.) down</td><td><kbd>Ctrl</kbd>+<kbd>↑</kbd></td><td><kbd>⌘</kbd>+<kbd>↑</kbd></td></tr><tr><td><kbd>Alt</kbd>+<kbd>↓</kbd></td><td><kbd>⌥</kbd>+<kbd>↓</kbd></td></tr></tbody></table></figure>
+<figure class="table"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Bring up inline formatting toolbar (arrow keys <kbd><span>←</span></kbd>,<kbd><span>→</span></kbd> to navigate, <kbd>Enter</kbd> to apply)</td><td><kbd>Alt</kbd>+<kbd>F10</kbd></td><td><kbd>⌥</kbd>+<kbd>F10</kbd></td></tr><tr><td>Bring up block formatting toolbar</td><td><kbd>Alt</kbd>+<kbd>F10</kbd></td><td><kbd>⌥</kbd>+<kbd>F10</kbd></td></tr><tr><td>Create <a href="Links.md">external link</a></td><td><kbd>Ctrl</kbd>+<kbd>K</kbd></td><td><kbd>⌘</kbd>+<kbd>K</kbd></td></tr><tr><td>Create <a href="Links.md">internal (note) link</a></td><td><kbd>Ctrl</kbd>+<kbd>L</kbd></td><td><kbd>⌘</kbd>+<kbd>L</kbd></td></tr><tr><td>Inserts current date and time at caret position</td><td><kbd>Alt</kbd>+<kbd>T</kbd>&nbsp;</td><td><kbd>⌥</kbd>+<kbd>T</kbd>&nbsp;</td></tr><tr><td>Increase paragraph indentation</td><td><kbd>Tab</kbd></td><td><kbd>⇥</kbd></td></tr><tr><td>Decrease paragraph indentation</td><td><kbd>Shift</kbd> + <kbd>Tab</kbd></td><td><kbd>⇧</kbd> + <kbd>⇥</kbd></td></tr><tr><td>Mark selected text as <a href="Developer-specific%20formatting.md">keyboard shortcut</a></td><td><kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>K</kbd></td><td><kbd>⌘</kbd>+ <kbd>⌥</kbd>+ <kbd>K</kbd></td></tr><tr><td>Insert&nbsp;<a class="reference-link" href="Math%20Equations.md">Math Equations</a></td><td><kbd>Ctrl</kbd> + <kbd>M</kbd></td><td><kbd>⌘</kbd>+ <kbd>M</kbd></td></tr><tr><td>Move blocks (lists, paragraphs, etc.) up</td><td><kbd>Ctrl</kbd>+<kbd>↑</kbd>&nbsp;</td><td><kbd>⌘</kbd>+<kbd>↑</kbd>&nbsp;</td></tr><tr><td><kbd>Alt</kbd>+<kbd>↑</kbd></td><td><kbd>⌥</kbd>+<kbd>↑</kbd></td></tr><tr><td>Move blocks (lists, paragraphs, etc.) down</td><td><kbd>Ctrl</kbd>+<kbd>↑</kbd></td><td><kbd>⌘</kbd>+<kbd>↑</kbd></td></tr><tr><td><kbd>Alt</kbd>+<kbd>↓</kbd></td><td><kbd>⌥</kbd>+<kbd>↓</kbd></td></tr></tbody></table></figure>
 
 ## Common shortcuts