From 46bb49f40baaf10f6b14fcb411bbd3762704a726 Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Wed, 15 Oct 2025 15:48:00 -0700 Subject: [PATCH] Add "Related documentation" on action reference documentation. --- docs/reference/command-line/actions/borg.md | 5 +++++ docs/reference/command-line/actions/check.md | 4 ++++ .../command-line/actions/config-bootstrap.md | 5 +++++ .../reference/command-line/actions/config-generate.md | 5 +++++ .../reference/command-line/actions/config-validate.md | 5 +++++ docs/reference/command-line/actions/create.md | 5 +++++ docs/reference/command-line/actions/extract.md | 5 +++++ docs/reference/command-line/actions/info.md | 5 +++++ docs/reference/command-line/actions/list.md | 5 +++++ docs/reference/command-line/actions/mount.md | 5 +++++ docs/reference/command-line/actions/repo-create.md | 11 ++++++++--- docs/reference/command-line/actions/repo-info.md | 5 +++++ docs/reference/command-line/actions/repo-list.md | 5 +++++ docs/reference/command-line/actions/restore.md | 5 +++++ docs/reference/command-line/actions/transfer.md | 4 ++++ docs/reference/command-line/actions/umount.md | 5 +++++ 16 files changed, 81 insertions(+), 3 deletions(-) diff --git a/docs/reference/command-line/actions/borg.md b/docs/reference/command-line/actions/borg.md index a8abdc02..c4fe84f8 100644 --- a/docs/reference/command-line/actions/borg.md +++ b/docs/reference/command-line/actions/borg.md @@ -8,3 +8,8 @@ eleventyNavigation: ``` {% include borgmatic/command-line/borg.txt %} ``` + + +## Related documentation + + * [How to run arbitrary Borg commands](https://torsion.org/borgmatic/how-to/run-arbitrary-borg-commands/) diff --git a/docs/reference/command-line/actions/check.md b/docs/reference/command-line/actions/check.md index 0c9396b2..befed8b5 100644 --- a/docs/reference/command-line/actions/check.md +++ b/docs/reference/command-line/actions/check.md @@ -8,3 +8,7 @@ eleventyNavigation: ``` {% include borgmatic/command-line/check.txt %} ``` + +## Related documentation + + * [Consistency checks](https://torsion.org/borgmatic/reference/configuration/consistency-checks/) diff --git a/docs/reference/command-line/actions/config-bootstrap.md b/docs/reference/command-line/actions/config-bootstrap.md index 45d1d33b..8608c7a7 100644 --- a/docs/reference/command-line/actions/config-bootstrap.md +++ b/docs/reference/command-line/actions/config-bootstrap.md @@ -8,3 +8,8 @@ eleventyNavigation: ``` {% include borgmatic/command-line/config-bootstrap.txt %} ``` + + +## Related documentation + + * [Extract the configuration files used to create an archive](https://torsion.org/borgmatic/how-to/extract-a-backup/#extract-the-configuration-files-used-to-create-an-archive) diff --git a/docs/reference/command-line/actions/config-generate.md b/docs/reference/command-line/actions/config-generate.md index 539f8429..9891815e 100644 --- a/docs/reference/command-line/actions/config-generate.md +++ b/docs/reference/command-line/actions/config-generate.md @@ -8,3 +8,8 @@ eleventyNavigation: ``` {% include borgmatic/command-line/config-generate.txt %} ``` + + +## Related documentation + + * [Configuration](https://torsion.org/borgmatic/how-to/set-up-backups/#configuration) diff --git a/docs/reference/command-line/actions/config-validate.md b/docs/reference/command-line/actions/config-validate.md index 10c5e756..b5e01aba 100644 --- a/docs/reference/command-line/actions/config-validate.md +++ b/docs/reference/command-line/actions/config-validate.md @@ -8,3 +8,8 @@ eleventyNavigation: ``` {% include borgmatic/command-line/config-validate.txt %} ``` + + +## Related documentation + + * [Validation](https://torsion.org/borgmatic/how-to/set-up-backups/#validation) diff --git a/docs/reference/command-line/actions/create.md b/docs/reference/command-line/actions/create.md index 22a0ad93..180ad5b0 100644 --- a/docs/reference/command-line/actions/create.md +++ b/docs/reference/command-line/actions/create.md @@ -8,3 +8,8 @@ eleventyNavigation: ``` {% include borgmatic/command-line/create.txt %} ``` + + +## Related documentation + + * [Backups](https://torsion.org/borgmatic/how-to/set-up-backups/#backups) diff --git a/docs/reference/command-line/actions/extract.md b/docs/reference/command-line/actions/extract.md index 292d98ab..bcab4037 100644 --- a/docs/reference/command-line/actions/extract.md +++ b/docs/reference/command-line/actions/extract.md @@ -8,3 +8,8 @@ eleventyNavigation: ``` {% include borgmatic/command-line/extract.txt %} ``` + + +## Related documentation + + * [How to extract a backup](https://torsion.org/borgmatic/how-to/extract-a-backup/) diff --git a/docs/reference/command-line/actions/info.md b/docs/reference/command-line/actions/info.md index 2a004d4b..962c5af4 100644 --- a/docs/reference/command-line/actions/info.md +++ b/docs/reference/command-line/actions/info.md @@ -8,3 +8,8 @@ eleventyNavigation: ``` {% include borgmatic/command-line/info.txt %} ``` + + +## Related documentation + + * [How to inspect your backups](https://torsion.org/borgmatic/how-to/inspect-your-backups/) diff --git a/docs/reference/command-line/actions/list.md b/docs/reference/command-line/actions/list.md index 87cb6839..ddb91f15 100644 --- a/docs/reference/command-line/actions/list.md +++ b/docs/reference/command-line/actions/list.md @@ -8,3 +8,8 @@ eleventyNavigation: ``` {% include borgmatic/command-line/list.txt %} ``` + + +## Related documentation + + * [How to inspect your backups](https://torsion.org/borgmatic/how-to/inspect-your-backups/) diff --git a/docs/reference/command-line/actions/mount.md b/docs/reference/command-line/actions/mount.md index bc671b23..82914d0f 100644 --- a/docs/reference/command-line/actions/mount.md +++ b/docs/reference/command-line/actions/mount.md @@ -8,3 +8,8 @@ eleventyNavigation: ``` {% include borgmatic/command-line/mount.txt %} ``` + + +## Related documentation + + * [Mount a filesystem](https://torsion.org/borgmatic/how-to/extract-a-backup/#mount-a-filesystem) diff --git a/docs/reference/command-line/actions/repo-create.md b/docs/reference/command-line/actions/repo-create.md index 7b5a48fb..d0820e52 100644 --- a/docs/reference/command-line/actions/repo-create.md +++ b/docs/reference/command-line/actions/repo-create.md @@ -1,10 +1,15 @@ --- -title: transfer +title: repo-create eleventyNavigation: - key: transfer + key: repo-create parent: 🎬 Actions --- ``` -{% include borgmatic/command-line/transfer.txt %} +{% include borgmatic/command-line/repo-create.txt %} ``` + + +## Related documentation + + * [Repository creation](https://torsion.org/borgmatic/how-to/set-up-backups/#repository-creation) diff --git a/docs/reference/command-line/actions/repo-info.md b/docs/reference/command-line/actions/repo-info.md index 0506d127..9d7ca57d 100644 --- a/docs/reference/command-line/actions/repo-info.md +++ b/docs/reference/command-line/actions/repo-info.md @@ -8,3 +8,8 @@ eleventyNavigation: ``` {% include borgmatic/command-line/repo-info.txt %} ``` + + +## Related documentation + + * [How to inspect your backups](https://torsion.org/borgmatic/how-to/inspect-your-backups/) diff --git a/docs/reference/command-line/actions/repo-list.md b/docs/reference/command-line/actions/repo-list.md index 1f12a5d4..551e97ed 100644 --- a/docs/reference/command-line/actions/repo-list.md +++ b/docs/reference/command-line/actions/repo-list.md @@ -8,3 +8,8 @@ eleventyNavigation: ``` {% include borgmatic/command-line/repo-list.txt %} ``` + + +## Related documentation + + * [How to inspect your backups](https://torsion.org/borgmatic/how-to/inspect-your-backups/) diff --git a/docs/reference/command-line/actions/restore.md b/docs/reference/command-line/actions/restore.md index 69ed01b9..47e0d214 100644 --- a/docs/reference/command-line/actions/restore.md +++ b/docs/reference/command-line/actions/restore.md @@ -8,3 +8,8 @@ eleventyNavigation: ``` {% include borgmatic/command-line/restore.txt %} ``` + + +## Related documentation + + * [Database restoration](https://torsion.org/borgmatic/how-to/backup-your-databases/#database-restoration) diff --git a/docs/reference/command-line/actions/transfer.md b/docs/reference/command-line/actions/transfer.md index 7b5a48fb..b0eee89a 100644 --- a/docs/reference/command-line/actions/transfer.md +++ b/docs/reference/command-line/actions/transfer.md @@ -8,3 +8,7 @@ eleventyNavigation: ``` {% include borgmatic/command-line/transfer.txt %} ``` + +## Related documentation + + * [Upgrade Borg 1.2 to 2.0](https://torsion.org/borgmatic/how-to/upgrade/#borg-1.2-to-2.0) diff --git a/docs/reference/command-line/actions/umount.md b/docs/reference/command-line/actions/umount.md index a181ed1c..29225838 100644 --- a/docs/reference/command-line/actions/umount.md +++ b/docs/reference/command-line/actions/umount.md @@ -8,3 +8,8 @@ eleventyNavigation: ``` {% include borgmatic/command-line/umount.txt %} ``` + + +## Related documentation + + * [Mount a filesystem](https://torsion.org/borgmatic/how-to/extract-a-backup/#mount-a-filesystem)