add note about how to get more info about config options

This is related to *should document the options for KQLMAGIC_NOTEBOOK_APP and what it means*, issue microsoft#84.
ForrestTrepte · Feb 7, 2022 · 1aba9b5 · 1aba9b5
1 parent 3dec41e
commit 1aba9b5
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/notebooks/QuickStart.ipynb b/notebooks/QuickStart.ipynb
@@ -66,9 +66,12 @@
     "\n",
     "#%env KQLMAGIC_LOG_LEVEL=DEBUG\n",
     "#%env KQLMAGIC_LOG_FILE_MODE=Append\n",
-    "# %env KQLMAGIC_LOG_FILE=michael.log\n",
+    "#%env KQLMAGIC_LOG_FILE=michael.log\n",
     "#%env KQLMAGIC_LOG_FILE_PREFIX=myLog\n",
-    "#%env KQLMAGIC_DEVICE_CODE_NOTIFICATION_EMAIL=SMTPEndPoint='endpoint';SMTPPort='port';sendFrom='from';sendFromPassword='password';sendTo='to';context='text'"
+    "#%env KQLMAGIC_DEVICE_CODE_NOTIFICATION_EMAIL=SMTPEndPoint='endpoint';SMTPPort='port';sendFrom='from';sendFromPassword='password';sendTo='to';context='text'\n",
+    "\n",
+    "# For more information about configuration options, you can run the following command:\n",
+    "#%kql --config"
    ]
   },
   {

diff --git a/notebooks/QuickStartAI.ipynb b/notebooks/QuickStartAI.ipynb
@@ -65,7 +65,10 @@
     "#%env KQLMAGIC_LOG_LEVEL=DEBUG\n",
     "#%env KQLMAGIC_LOG_FILE_MODE=Append\n",
     "#%env KQLMAGIC_LOG_FILE=michael.log\n",
-    "#%env KQLMAGIC_LOG_FILE_PREFIX=myLog"
+    "#%env KQLMAGIC_LOG_FILE_PREFIX=myLog\n",
+    "\n",
+    "# For more information about configuration options, you can run the following command:\n",
+    "#%kql --config"
    ]
   },
   {

diff --git a/notebooks/QuickStartLA.ipynb b/notebooks/QuickStartLA.ipynb
@@ -65,7 +65,10 @@
     "#%env KQLMAGIC_LOG_LEVEL=DEBUG\n",
     "#%env KQLMAGIC_LOG_FILE_MODE=Append\n",
     "#%env KQLMAGIC_LOG_FILE=michael.log\n",
-    "#%env KQLMAGIC_LOG_FILE_PREFIX=myLog"
+    "#%env KQLMAGIC_LOG_FILE_PREFIX=myLog\n",
+    "\n",
+    "# For more information about configuration options, you can run the following command:\n",
+    "#%kql --config"
    ]
   },
   {