From 1c42023e8e6543b21b184f3dbfc82fa2ec645672 Mon Sep 17 00:00:00 2001
From: YuviPanda <yuvipanda@gmail.com>
Date: Tue, 5 Dec 2023 11:04:04 -0800
Subject: [PATCH] Add note about user homedirectory names being escaped

---
 dashboards/user.jsonnet | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/dashboards/user.jsonnet b/dashboards/user.jsonnet
index 77374d5..c9be28c 100755
--- a/dashboards/user.jsonnet
+++ b/dashboards/user.jsonnet
@@ -111,6 +111,13 @@ local homedirSharedUsage = graphPanel.new(
 
     Requires https://github.com/yuvipanda/prometheus-dirsize-exporter to
     be set up.
+
+    Similar to server pod names, user names will be *encoded* here
+    using the escapism python library (https://github.com/minrk/escapism).
+    You can unencode them with the following python snippet:
+
+    from escapism import unescape
+    unescape('<escaped-username>', '-')
   |||,
   formatY1='bytes',
   datasource='$PROMETHEUS_DS'