home-assistant.io icon indicating copy to clipboard operation
home-assistant.io copied to clipboard

Increase visibility of how to edit configuration.yaml

Open Erisa opened this issue 1 year ago • 2 comments

Feedback

When adding the Emby integration I was told that I needed to edit configuration.yaml and was taken to this page: https://www.home-assistant.io/integrations/emby

On this page it tells me what to edit on configuration.yaml, but as a newcomer to Home Assistant it provides no direction on what this file is or where to find it.

Eventually and after asking, I discovered both https://www.home-assistant.io/docs/configuration/ and https://www.home-assistant.io/common-tasks/os/ which shed a lot of light on this subject.

My proposal is that the {% term system is used like it is for words in the glossary It may also help to add a non-technical/high-level explainer to the https://www.home-assistant.io/docs/configuration/ page.

Something like this maybe in glossary:

- term: configuration.yaml
  definition: >-
    Some parts of Home Assistant configuration require you to edit `configuration.y`ml. This file contains integrations to be loaded with their configurations.
  link: /docs/configuration/

The only reason this is not a PR is because I tried and encountered two critical issues:

  1. There would have to be a huge find/replace across the entire docs, when I tried doing this ist caught a lot of unneeded things like comments and it would have to be manually and tediously reviewed for accuracy.
  2. My change to the glossary didn't take, I rashly assume it choked on the dot in the term name?
  Liquid Exception: Syntax error in tag 'term' while parsing the following options: configuration.yaml Valid syntax: {% term <term> [<text>] %} in /mnt/c/Users/Erisa/Work/home-assistant.io/source/_integrations/acer_projector.markdown
                    ------------------------------------------------
      Jekyll 4.3.3   Please append `--trace` to the `build` command
                     for any additional information or backtrace.
                    ------------------------------------------------

URL

https://www.home-assistant.io/integrations/emby

Version

No response

Additional information

No response

Erisa avatar Mar 18 '24 02:03 Erisa

Hey there @mezz64, mind taking a look at this feedback as it has been labeled with an integration (emby) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of emby can trigger bot actions by commenting:

  • @home-assistant close Closes the feedback.
  • @home-assistant rename Awesome new title Renames the feedback.
  • @home-assistant reopen Reopen the feedback.
  • @home-assistant unassign emby Removes the current integration label and assignees on the feedback, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information) to the feedback.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information) on the feedback.

home-assistant[bot] avatar Mar 18 '24 02:03 home-assistant[bot]

Excellent suggestions, @Erisa :+1:

c0ffeeca7 avatar May 13 '24 09:05 c0ffeeca7

Closing this as addressed by #32472, #32619, #32635

c0ffeeca7 avatar May 27 '24 08:05 c0ffeeca7