diff --git a/Gemfile b/Gemfile index 909738d85e8..fd9f6665697 100644 --- a/Gemfile +++ b/Gemfile @@ -11,7 +11,7 @@ group :development do # > 2.1.0 causes slowdowns https://github.com/sass/sassc-ruby/issues/189 gem 'sassc', '2.1.0' gem 'rubocop', '1.64.1' - gem 'ruby-lsp', '0.17.3' + gem 'ruby-lsp', '0.17.4' gem 'rackup', '2.1.0' end diff --git a/Gemfile.lock b/Gemfile.lock index cd20ad0bdbe..f8877262411 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -86,7 +86,7 @@ GEM pathutil (0.16.2) forwardable-extended (~> 2.6) prism (0.30.0) - public_suffix (5.1.0) + public_suffix (5.1.1) racc (1.8.0) rack (3.1.3) rack-protection (4.0.0) @@ -121,7 +121,7 @@ GEM unicode-display_width (>= 2.4.0, < 3.0) rubocop-ast (1.31.3) parser (>= 3.3.1.0) - ruby-lsp (0.17.3) + ruby-lsp (0.17.4) language_server-protocol (~> 3.17.0) prism (>= 0.29.0, < 0.31) rbs (>= 3, < 4) @@ -142,7 +142,7 @@ GEM rack-protection (= 4.0.0) rack-session (>= 2.0.0, < 3) tilt (~> 2.0) - sorbet-runtime (0.5.11435) + sorbet-runtime (0.5.11439) stringex (2.8.6) strscan (3.1.0) terminal-table (3.0.2) @@ -169,7 +169,7 @@ DEPENDENCIES rackup (= 2.1.0) rake (= 13.2.1) rubocop (= 1.64.1) - ruby-lsp (= 0.17.3) + ruby-lsp (= 0.17.4) sass-globbing (= 1.1.5) sassc (= 2.1.0) sinatra (= 4.0.0) diff --git a/_config.yml b/_config.yml index 83377b6fbee..fa7a68b274f 100644 --- a/_config.yml +++ b/_config.yml @@ -108,8 +108,8 @@ social: # Home Assistant release details current_major_version: 2024 current_minor_version: 6 -current_patch_version: 3 -date_released: 2024-06-15 +current_patch_version: 4 +date_released: 2024-06-21 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. @@ -177,6 +177,12 @@ defaults: values: sitemap: false + - scope: + path: "blueprints/**/*.yaml" + values: + render_with_liquid: false + layout: none + # Support for files Jekyll will normally exclude include: - "_headers" diff --git a/source/_docs/configuration.markdown b/source/_docs/configuration.markdown index dbee90a3ba9..f93267df57b 100644 --- a/source/_docs/configuration.markdown +++ b/source/_docs/configuration.markdown @@ -29,36 +29,44 @@ Example of a configuration.yaml file, accessed using the File editor add-on on a ## Editing `configuration.yaml` -How you edit your `configuration.yaml` file depends on your editor preferences and the [installation method](/installation/#advanced-installation-methods) you used to set up Home Assistant. +How you edit your `configuration.yaml` file depends on your editor preferences and the [installation method](/installation/#advanced-installation-methods) you used to set up Home Assistant. Follow these steps: + +1. [Set up file access](#to-set-up-access-to-the-files-and-prepare-an-editor). +2. [Locate the config directory](#to-find-the-configuration-directory). +3. Edit your `configuration.yaml` file. +4. Save your changes and [reload the configuration](#reloading-the-configuration-to-apply-changes) to apply the changes. ### To set up access to the files and prepare an editor Before you can edit a file, you need to know how to access files in Home Assistant and setup an editor. File access depends on your [installation method](/installation/#advanced-installation-methods). If you use {% term "Home Assistant Operating System" %} or {% term "Home Assistant Supervised" %}, you can use editor add-ons, for example, but not if you use {% term "Home Assistant Core" %} or {% term "Home Assistant Container" %}. -1. To set up file access, follow the steps for your [installation method](/installation/#advanced-installation-methods): +To set up file access, follow the steps for your [installation method](/installation/#advanced-installation-methods): - - [Configure file access on the Operating System](/common-tasks/os/#configuring-access-to-files): - - If you are unsure which option to choose, install the [file editor add-on](/common-tasks/os/#installing-and-using-the-file-editor-add-on). - - Alternatively, use the [Studio Code Server add-on](/common-tasks/os/#installing-and-using-the-visual-studio-code-vsc-add-on). This editor offers live syntax checking and auto-fill of various Home Assistant entities. But it looks more complex than the file editor. - - If you prefer to use a file editor on your computer, use the [Samba add-on](/common-tasks/os/#installing-and-using-the-samba-add-on). - - [Configure file access on Supervised](/common-tasks/supervised/#configuring-access-to-files): - - Using the [File editor add-on](/common-tasks/supervised/#installing-and-using-the-file-editor-add-on). - - Using the [Studio Code Server add-on](/common-tasks/supervised/#installing-and-using-the-visual-studio-code-vsc-add-on). - - Using the [Samba add-on](/common-tasks/supervised/#installing-and-using-the-samba-add-on). +- [Configure file access on the Operating System](/common-tasks/os/#configuring-access-to-files): + - If you are unsure which option to choose, install the [file editor add-on](/common-tasks/os/#installing-and-using-the-file-editor-add-on). + - Alternatively, use the [Studio Code Server add-on](/common-tasks/os/#installing-and-using-the-visual-studio-code-vsc-add-on). This editor offers live syntax checking and auto-fill of various Home Assistant entities. But it looks more complex than the file editor. + - If you prefer to use a file editor on your computer, use the [Samba add-on](/common-tasks/os/#installing-and-using-the-samba-add-on). +- [Configure file access on Supervised](/common-tasks/supervised/#configuring-access-to-files): + - Using the [File editor add-on](/common-tasks/supervised/#installing-and-using-the-file-editor-add-on). + - Using the [Studio Code Server add-on](/common-tasks/supervised/#installing-and-using-the-visual-studio-code-vsc-add-on). + - Using the [Samba add-on](/common-tasks/supervised/#installing-and-using-the-samba-add-on). -2. To look up the path to your configuration directory, go to {% my system_health title="**Settings** > **System** > **Repairs**" %}. +### To find the configuration directory + +1. To look up the path to your configuration directory, go to {% my system_health title="**Settings** > **System** > **Repairs**" %}. - Select the three dots menu and select **System information**. ![Show system information option](/images/screenshots/System_information_menu.png) -3. Find out the location of the **Configuration directory**. +2. Find out the location of the **Configuration directory**. ![Screenshot showing the top of the system information panel](/images/screenshots/system_information.png) - Unless you changed the file structure, the default is as follows: - - {% term "Home Assistant Operating System" %}: the `configuration.yaml` is in the `/config` folder of the installation. - {% term "Home Assistant Container" %}: the `configuration.yaml` is in the config folder that you mounted in your container. - {% term "Home Assistant Core" %}: the `configuration.yaml` is in the config folder passed to the `hass` command (default is `~/.homeassistant`). +3. Once you located the config folder, you can edit your `configuration.yaml` file. ## Validating the configuration diff --git a/source/_docs/frontend.markdown b/source/_docs/frontend.markdown index 2b3cbcc678a..3320902fbb7 100644 --- a/source/_docs/frontend.markdown +++ b/source/_docs/frontend.markdown @@ -3,19 +3,52 @@ title: "Frontend of Home Assistant" description: "Frontend of Home Assistant." --- -The Home Assistant frontend allows users to browse and control the state of their house, manage their automations and configure integrations. -The frontend is built with [Polymer](https://www.polymer-project.org/). +The Home Assistant [frontend integration](/integrations/frontend/) provides the graphical user interface that allows you to browse and control the state of your house, manage automations, and configure integrations.

-
+Home Assistant comes with a [default dashboard](/dashboards/dashboards/#home-assistant-default-dashboards). But you can also create and customize your own dashboards. - If you're looking to contribute to the frontend, please refer to the [Frontend Development documentation](/developers/frontend/). +## Creating and styling your own dashboards -
+To learn how to create and style your own dashboards, refer to the following topics: -## Icons +- [Dashboard introduction](/dashboards/) +- [Types of dashboards](/dashboards/dashboards/) +- [Views](/dashboards/views/) +- [Dashboard cards](/dashboards/cards/) +- [Badges](/dashboards/badges/) +- [Themes](/integrations/frontend/) +- [Icons](/docs/frontend/icons/) -Home Assistant utilizes the community-driven [Material Design Icons](https://pictogrammers.com/library/mdi/) project for icons in the frontend. The [Icons section](/docs/frontend/icons/) has more information on how to use icons and suggest new ones. +## Organizing and filtering data + +To learn how to organize and filter your data on an existing dashboard, refer to the following topics: + +- [Grouping](/docs/organizing/) into [areas](/docs/organizing/areas/), [floors](/docs/organizing/floors/), [labels](/docs/organizing/labels/), and [categories](/docs/organizing/categories/) +- [Filtering](/docs/organizing/filtering) + +## User- or browser-dependent settings, general settings + +### User- or browser-dependent settings + +Some of the frontend settings depend on the user. Other settings can be set by client. This allows you for example to have different languages per user, and a different theme depending on the device that is used to display Home Assistant. + +To change these settings, in the bottom left, select your username to open your {% my profile title="**User profile**" %}. + +- To change general settings such as language, number and time format, go to the **User settings**. +- To change browser dependent settings such as the theme, default dashboard, or whether or not to show the sidebar, change the **Browser settings**. + +### Themes + +Themes can be set per browser. In the {% my profile title="**User profile**" %}, you can define some theme settings, such as whether you want a light or dark theme. However, more detailed theme settings require YAML configuration. Refer to the documentation of the [frontend integration](/integrations/frontend/). + +### General settings + +Some of the settings, such as location and currency, were defined during the onboarding process. They can be changed under {% my general title="**Settings** > **System** > **General**" %}. Refer to the documentation on [setup basic information](/docs/configuration/basic/). + +## Apps for Android and iOS + +If you are looking for information on Home Assistant for Android or iOS, refer to the [documentation for the Companion Apps](https://companion.home-assistant.io/). diff --git a/source/_docs/frontend/icons.markdown b/source/_docs/frontend/icons.markdown index 7499aa6dc75..ed95d33b146 100644 --- a/source/_docs/frontend/icons.markdown +++ b/source/_docs/frontend/icons.markdown @@ -1,6 +1,15 @@ --- title: "Icons" description: "Material Design Icons in the Home Assistant frontend" +related: + - docs: /docs/frontend/ + title: Frontend + - docs: /dashboards/cards/ + title: Dashboard cards + - docs: /docs/configuration/customizing-devices/ + title: Customizing entities + - docs: https://pictogrammers.com/library/mdi/ + title: Material Design Icons ---

@@ -11,13 +20,13 @@ Home Assistant utilizes the community-driven [Material Design Icons](https://pic ## Default icons -Every entity in Home Assistant has a default icon assigned to it. There are way too many to list out here, but you'll see them in your dashboard. You can [customize any of your entities](/docs/configuration/customizing-devices/#icon) to change the icons displayed to you. +Every entity in Home Assistant has a default icon assigned to it. There are way too many to list out here, but you'll see them in your dashboard. You can [customize any of your entities](/docs/configuration/customizing-devices/) to change the icons displayed to you. ## Finding icons ### Icon picker -The most common way you can find icons is by using the icon picker built right into Home Assistant. Select the "Icon" field when customizing an entity and start typing. The list will filter to icons that match your search criteria. You can also scroll through all available icons when the field is empty. +The most common way you can find icons is by using the icon picker built right into Home Assistant. Select the **Icon** field when customizing an entity and start typing. The list will filter to icons that match your search criteria. You can also scroll through all available icons when the field is empty.

Icon Picker in Home Assistant @@ -29,6 +38,8 @@ The most common way you can find icons is by using the icon picker built right i +For more detailed steps on customizing entities, including their icon, refer to [customizing entities](/docs/configuration/customizing-devices/). + ### Material design icons picker browser extension The easiest way to browse and find icons outside of Home Assistant is with the official [Material Design Icons Picker](https://github.com/Pictogrammers/MaterialDesignIcons-Picker) browser extension. The extension is available for Chrome, Firefox, and Edge and is maintained by the MDI team. @@ -71,7 +82,7 @@ If you have an idea for an icon that isn't currently in the library, but are not If you want to contribute a new icon to the library, familiarize yourself with the [System icons guidelines](https://material.io/design/iconography/system-icons.html#design-principles) in the Material Design system. Then create your icon and [submit it to the Pictogrammers team for review](https://github.com/Templarian/MaterialDesign/issues/new?assignees=&labels=Icon+Request%2CContribution&template=2_contribution.yml). -#### Tips for Creating New Icons +#### Tips for creating new icons - Really pay attention to [Material Design guidelines](https://material.io/design/iconography/system-icons.html#design-principles). - Keep in mind that icons are meant to be contextual, not literal. @@ -79,6 +90,6 @@ If you want to contribute a new icon to the library, familiarize yourself with t - If you're unsure, open an issue on their GitHub. They're more than happy to help you! - Not all icons make it into the library and that is okay! -### Suggesting an Icon Alias +### Suggesting an icon alias Sometimes an icon exists, but you aren't able to find it with the terms you were searching for. If this has ever happened to you, please [open an issue with the Pictogrammers team to suggest new aliases](https://github.com/Templarian/MaterialDesign/issues/new?assignees=&labels=Alias&template=4_alias.yml) that can be added to existing icons. diff --git a/source/_includes/asides/help_navigation.html b/source/_includes/asides/help_navigation.html index 532719243d0..3c3fdc9c923 100644 --- a/source/_includes/asides/help_navigation.html +++ b/source/_includes/asides/help_navigation.html @@ -9,6 +9,9 @@ +

  • + {% active_link /help/reporting_issues/ Reporting issues %} +
  • Governance