Skip to content

Commit

Permalink
Move backup to installation independent section of common tasks
Browse files Browse the repository at this point in the history
  • Loading branch information
c0ffeeca7 committed Jan 3, 2025
1 parent 5e0c64e commit 2a7e2b3
Show file tree
Hide file tree
Showing 13 changed files with 22 additions and 13 deletions.
2 changes: 1 addition & 1 deletion source/_docs/configuration.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion source/_includes/common-tasks/data_disk.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion source/_includes/common-tasks/specific_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" %}

Expand Down
2 changes: 1 addition & 1 deletion source/_includes/common-tasks/update.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/backup.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 3 additions & 2 deletions source/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -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 /
Expand Down
4 changes: 4 additions & 0 deletions source/common-tasks/container.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
Expand Down
4 changes: 4 additions & 0 deletions source/common-tasks/core.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
Expand Down
2 changes: 2 additions & 0 deletions source/common-tasks/general.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion source/common-tasks/os.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 0 additions & 1 deletion source/common-tasks/supervised.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ related:


{% include common-tasks/file_access.md %}
{% include common-tasks/backups.md %}

## Update

Expand Down
6 changes: 3 additions & 3 deletions source/getting-started/configuration.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion source/installation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ <h2>Advanced installation methods</h2>
<td>{% icon "noto-v1:check-mark" %}<sup>2</sup></td>
</tr>
<tr>
<td><a href="/common-tasks/os/#backups" target="_blank">Backups</a></td>
<td><a href="/common-tasks/general/#backups" target="_blank">Backups</a></td>
<td>{% icon "openmoji:check-mark" %}</td>
<td>{% icon "noto-v1:check-mark" %}<sup>3</sup></td>
<td>{% icon "noto-v1:check-mark" %}<sup>3</sup></td>
Expand Down

0 comments on commit 2a7e2b3

Please sign in to comment.