From ac5ccec3c34daf0b1cd05f66cb0bbed091511523 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Fri, 3 Jan 2025 16:26:28 +0100 Subject: [PATCH] Move backup to installation independent section of common tasks (#36679) --- source/_docs/configuration.markdown | 2 +- source/_includes/common-tasks/data_disk.md | 2 +- source/_includes/common-tasks/specific_version.md | 2 +- source/_includes/common-tasks/update.md | 2 +- source/_integrations/backup.markdown | 2 +- source/_redirects | 5 +++-- source/common-tasks/container.markdown | 4 ++++ source/common-tasks/core.markdown | 4 ++++ source/common-tasks/general.markdown | 2 ++ source/common-tasks/os.markdown | 1 - source/common-tasks/supervised.markdown | 1 - source/getting-started/configuration.markdown | 6 +++--- source/installation/index.html | 2 +- 13 files changed, 22 insertions(+), 13 deletions(-) diff --git a/source/_docs/configuration.markdown b/source/_docs/configuration.markdown index b73bfb1378f..77811b8ca69 100644 --- a/source/_docs/configuration.markdown +++ b/source/_docs/configuration.markdown @@ -6,7 +6,7 @@ related: title: YAML syntax - docs: /docs/configuration/secrets title: Storing credentials in `secrets.yaml` file - - docs: /common-tasks/os/#backups + - docs: /common-tasks/general/#backups title: Creating and restoring backups - docs: /integrations/backup/docs/tools/dev-tools/#reloading-the-yaml-configuration title: Creating backups for Home Assistant Container and Core diff --git a/source/_includes/common-tasks/data_disk.md b/source/_includes/common-tasks/data_disk.md index 0909abd5200..84eebf1dc73 100644 --- a/source/_includes/common-tasks/data_disk.md +++ b/source/_includes/common-tasks/data_disk.md @@ -77,7 +77,7 @@ The aim is to migrate the data from system 1 to system 2. One way to do this is To migrate an external data disk from one system to another, follow these steps: -1. [Create a backup](/common-tasks/os/#backups) of both systems and store these backups on another system (not strictly necessary, but recommended just in case, at least for the important data). +1. [Create a backup](/common-tasks/general/#backups) of both systems and store these backups on another system (not strictly necessary, but recommended just in case, at least for the important data). 2. Shut down system 1 and remove the data disk. 3. Make sure system 2 has Home Assistant OS installed, and Home Assistant is up and running. Home Assistant is using the data disk (partition) on the boot drive (e.g. SD card) at this point. 4. Make sure system 2 has completed the basic [onboarding](/getting-started/onboarding/) steps, including the last steps where devices are discovered automatically. diff --git a/source/_includes/common-tasks/specific_version.md b/source/_includes/common-tasks/specific_version.md index fe9c4ab215e..69406162d8a 100644 --- a/source/_includes/common-tasks/specific_version.md +++ b/source/_includes/common-tasks/specific_version.md @@ -20,7 +20,7 @@ ha core update --version {{current_version}} --backup _The_ `--backup` _flag here ensures that you have a partial backup of your current setup in case you need to downgrade later._ -To downgrade your installation, do a [partial restore of a backup](/common-tasks/os/#backups) instead. +To downgrade your installation, do a [partial restore of a backup](/common-tasks/general/#backups) instead. {% elsif page.installation == "container" %} diff --git a/source/_includes/common-tasks/update.md b/source/_includes/common-tasks/update.md index 6d5c7087ade..73445d67c51 100644 --- a/source/_includes/common-tasks/update.md +++ b/source/_includes/common-tasks/update.md @@ -1,6 +1,6 @@ Best practice for updating Home Assistant Core: -1. Backup your installation{% if page.installation == "os" or page.installation == "supervised" %}, using the [backup functionality](/common-tasks/os/#backups) Home Assistant offers{% endif %}. +1. Backup your installation{% if page.installation == "os" or page.installation == "supervised" %}, using the [backup functionality](/common-tasks/general/#backups) Home Assistant offers{% endif %}. 2. Check the release notes for backward-incompatible changes on [Home Assistant release notes](/blog/categories/core/). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f` / `CMD + f`) and search for **Backward-incompatible changes**. {% if page.installation == "os" or page.installation == "supervised" %} 3. Select **Create backup before updating** in case you encounter an issue that requires a rollback. diff --git a/source/_integrations/backup.markdown b/source/_integrations/backup.markdown index 3a4b2acc437..d4b78ecdb43 100644 --- a/source/_integrations/backup.markdown +++ b/source/_integrations/backup.markdown @@ -23,7 +23,7 @@ related: The **Backup** {% term integration %} is used for {% term "Home Assistant Core" %} and {% term "Home Assistant Container" %} installations to create and download backups. This backup file can be used if you migrate to {% term "Home Assistant Operating System" %}. -Note: If you use {% term "Home Assistant Operating System" %} or {% term "Home Assistant Supervised" %} installation, this page is not for you. Instead, refer to the documentation on using the [built-in back up](/common-tasks/os/#backups). +Note: If you use {% term "Home Assistant Operating System" %} or {% term "Home Assistant Supervised" %} installation, this page is not for you. Instead, refer to the documentation on using the [built-in back up](/common-tasks/general/#backups). ## Actions diff --git a/source/_redirects b/source/_redirects index c7e9dc81ba7..10959560130 100644 --- a/source/_redirects +++ b/source/_redirects @@ -400,8 +400,9 @@ layout: null /cookbook/#infrastructure /examples/#infrastructure /cookbook/#automation-examples /examples /cookbook /examples -/common-tasks/os/#snapshots /common-tasks/os/#backups -/common-tasks/supervised/#snapshots /common-tasks/supervised/#backups +/common-tasks/os/#snapshots /common-tasks/general/#backups +/common-tasks/os/#backups /common-tasks/general/#backups +/common-tasks/supervised/#snapshots /common-tasks/general/#backups /more-info/unsupported/container /more-info/unsupported/software /integrations/zigbee /integrations/zha /examples / diff --git a/source/common-tasks/container.markdown b/source/common-tasks/container.markdown index bba727053b6..841e2af514b 100644 --- a/source/common-tasks/container.markdown +++ b/source/common-tasks/container.markdown @@ -4,6 +4,10 @@ description: "Common tasks for Home Assistant Container" installation: container --- +## Backup + +To learn how to back up the system or how to restore a system from a backup, refer to the backup documentation under [common tasks](/common-tasks/general/#backups). + ## Update {% include common-tasks/update.md %} diff --git a/source/common-tasks/core.markdown b/source/common-tasks/core.markdown index 60ea197ac7e..da09a975c86 100644 --- a/source/common-tasks/core.markdown +++ b/source/common-tasks/core.markdown @@ -4,6 +4,10 @@ description: "Common tasks for Home Assistant Core" installation: core --- +## Backup + +To learn how to back up the system or how to restore a system from a backup, refer to the backup documentation under [common tasks](/common-tasks/general/#backups). + ## Update {% include common-tasks/update.md %} diff --git a/source/common-tasks/general.markdown b/source/common-tasks/general.markdown index 125a8b12fa2..aa6bd725dbb 100644 --- a/source/common-tasks/general.markdown +++ b/source/common-tasks/general.markdown @@ -5,6 +5,8 @@ installation_name: "Installation independent" --- This section provides tasks that do not depend on a specific Home Assistant installation type or a specific integration. They may be referenced in other procedures. +{% include common-tasks/backups.md %} + {% include common-tasks/enable_entities.md %} ## Defining a custom polling interval diff --git a/source/common-tasks/os.markdown b/source/common-tasks/os.markdown index fcac32748eb..6f8f7bc993b 100644 --- a/source/common-tasks/os.markdown +++ b/source/common-tasks/os.markdown @@ -9,7 +9,6 @@ related: This section will provide guides to some common tasks and information which you will need in order to run, maintain, and edit your Home Assistant OS system. For further details on any particular subject, make sure to refer to the documentation for specific add-ons or topics listed here. {% include common-tasks/file_access.md %} -{% include common-tasks/backups.md %} ## Updating Home Assistant diff --git a/source/common-tasks/supervised.markdown b/source/common-tasks/supervised.markdown index ca6781d7151..c4c6cbf4d31 100644 --- a/source/common-tasks/supervised.markdown +++ b/source/common-tasks/supervised.markdown @@ -9,7 +9,6 @@ related: {% include common-tasks/file_access.md %} -{% include common-tasks/backups.md %} ## Update diff --git a/source/getting-started/configuration.markdown b/source/getting-started/configuration.markdown index f2637504869..45fe1b13274 100644 --- a/source/getting-started/configuration.markdown +++ b/source/getting-started/configuration.markdown @@ -8,7 +8,7 @@ related: title: configuration.yaml file - docs: /common-tasks/os/#network-storage title: Network storage - - docs: /common-tasks/os/#backups + - docs: /common-tasks/general/#backups title: Backups - docs: /voice_control/ title: Voice control @@ -40,8 +40,8 @@ You can back up your Home Assistant, add-on data, and configuration. Backups are To learn how to create a backup of your Home Assistant installation, select the link below that matches your installation type. -- {% term "Home Assistant Operating System" %}: [Creating a backup from OS](/common-tasks/os/#backups) -- {% term "Home Assistant Supervised" %}: [Creating a backup from Supervised](/common-tasks/supervised/#backups) +- {% term "Home Assistant Operating System" %}: [Creating a backup from OS](/common-tasks/general/#backups) +- {% term "Home Assistant Supervised" %}: [Creating a backup from Supervised](/common-tasks/general/#backups) - {% term "Home Assistant Core" %} or {% term "Home Assistant Container" %}: [Creating a backup from Core or Container](/integrations/backup/) ## Editing the configuration.yaml and configuring file access diff --git a/source/installation/index.html b/source/installation/index.html index a3fe1ba5579..f3bf6668838 100644 --- a/source/installation/index.html +++ b/source/installation/index.html @@ -332,7 +332,7 @@ toc: true {% icon "noto-v1:check-mark" %}2 - Backups + Backups {% icon "openmoji:check-mark" %} {% icon "noto-v1:check-mark" %}3 {% icon "noto-v1:check-mark" %}3