home-assistant / home-assistant.io

:blue_book: Home Assistant User documentation
https://www.home-assistant.io
Other
5.05k stars 7.33k forks source link

Update Card Documentations Configuration Variables #13207

Open zsarnett opened 4 years ago

zsarnett commented 4 years ago

https://www.home-assistant.io/lovelace/alarm-panel/#configuration-variables

Current Config Variables look daunting and advanced. Find a better way to view variables while keeping them together with the editor vs YAML

I currently don't have a plan or example of how these may look. Open to suggestions.

cadihowley commented 4 years ago

Would a table work?

Something like:

Configuration Variable Type Required? Description Options Default
type string yes alarm-panel
entity string yes Entity ID of alarm_control_panel domain
name string no Overwrites Friendly Name Current State of Alarm Entity
states list no Controls which states to have available
  • arm_home
  • arm_away
  • arm_away
  • arm_night
  • arm_custom_bypass
arm_home, arm_away
theme string no Set to any theme within themes.yaml
frenck commented 4 years ago

We had tables in the past, they get to narrow really quick

zsarnett commented 4 years ago

We are looking for a way to display the data to an Editor User. This is still catering to the YAML use. The YAML use will be in a new Section below the editor descriptions

cadihowley commented 4 years ago

Ok, I understand what we’re trying to do now. I’ll work on that!

stale[bot] commented 4 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

zsarnett commented 4 years ago

This is currently being worked on

github-actions[bot] commented 4 years ago

There hasn't been any activity on this issue recently. Due to the high number of incoming GitHub notifications, we have to clean some of the old issues, as many of them have already been resolved. If this issue is still relevant, please let us know by leaving a comment 👍 This issue has now has been marked as stale and will be closed if no further activity occurs. Thank you for your contributions.

zsarnett commented 4 years ago

Still have a lot of cards to do