#108 document UI options

2017-01-24 12:39:46 +01:00
parent 244fd90f35
commit e564f435fd
2 changed files with 17 additions and 0 deletions
--- a/docs/ui-options.rst
+++ b/docs/ui-options.rst
@@ -0,0 +1,16 @@
+==========
+UI Options
+==========
+
+Kubernetes Operational View has a few options to change the UI behavior.
+All these options are passed in the URL's fragment identifier (starting with ``#``) in the format of key/value pairs separated by semicolons.
+
+Example URL: ``https://kube-ops-view.example.org/#dashboard=true;reload=600``
+
+
+``dashboard``
+    Enable dashboard mode which hides the menu bar.
+``reload``
+    Reload the whole page after X seconds. This is useful for unattended TV screens running 24x7 to mitigate JavaScript memory leaks and browser crashes.
+``clusters``
+    Comma separated list of cluster IDs to show.