Skip to content

Commit abc72e3

Browse files
committed
Add FAQ entries for dashboard configuration issues
This update introduces new FAQ entries addressing common dashboard configuration problems, including how to resolve the "Edit dashboard" prompt and how to access the raw YAML code generated by the strategy. This aims to enhance user guidance and improve the overall user experience.
1 parent 81b531a commit abc72e3

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

docs/faq.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,42 @@
5151
1. Select `Settings` at the bottom of the sidebar.
5252
2. Select `Areas`.
5353
3. Select :material-pencil: of the area you want to get the id of.
54+
55+
??? question "I'm presented with "Edit dashboard" instead of the "Raw configuration editor". What do I do?"
56+
57+
This happens if you've removed the `options` key from your dashboard configuration.
58+
59+
The easiest way to fix this is to delete the dashboard and follow the steps of the
60+
[Basic Setup](getting-started/basic-setup.md) again.
61+
62+
??? question "Can I get the raw YAML code which the strategy generates?"
63+
64+
You can get the generated YAML, but **NOT** without "Taking Control" of the dashboard.
65+
66+
After setting up the strategy and options to your linking, you can follow these steps:
67+
68+
1. Click the :material-pencil: icon in the top right corner of the dashboard.<br>
69+
The **Raw configuration** editor will open.
70+
2. Delete the entire content of the editor and replace it with the following code:
71+
72+
```yaml
73+
strategy:
74+
type: custom:mushroom-strategy
75+
```
76+
77+
3. Click `Save` and exit the edit mode.
78+
4. Click the :material-pencil: icon in the top right corner of the dashboard.<br>
79+
The **Dashboard** editor will open.
80+
5. Click the three-dot menu in the top right corner of the editor.
81+
6. Select `Take control`.
82+
7. Click `Take control`.<br>
83+
`Start with an empty dashboard` will not have any effect.
84+
8. Click `Done` at the top right corner of the dashboard.
85+
86+
You can now edit the dashboard as you would normally do with any other dashboard.
87+
88+
To get the YAML:
89+
90+
1. Click the :material-pencil: icon in the top right corner of the dashboard.
91+
2. Click the three-dot menu in the top right corner of the dashboard.
92+
3. Select `Raw configuration editor`.

0 commit comments

Comments
 (0)