Browse Source

Add "Related documentation" on action reference documentation.

Dan Helfman 3 weeks ago
parent
commit
46bb49f40b

+ 5 - 0
docs/reference/command-line/actions/borg.md

@@ -8,3 +8,8 @@ eleventyNavigation:
 ```
 ```
 {% include borgmatic/command-line/borg.txt %}
 {% include borgmatic/command-line/borg.txt %}
 ```
 ```
+
+
+## Related documentation
+
+ * [How to run arbitrary Borg commands](https://torsion.org/borgmatic/how-to/run-arbitrary-borg-commands/)

+ 4 - 0
docs/reference/command-line/actions/check.md

@@ -8,3 +8,7 @@ eleventyNavigation:
 ```
 ```
 {% include borgmatic/command-line/check.txt %}
 {% include borgmatic/command-line/check.txt %}
 ```
 ```
+
+## Related documentation
+
+ * [Consistency checks](https://torsion.org/borgmatic/reference/configuration/consistency-checks/)

+ 5 - 0
docs/reference/command-line/actions/config-bootstrap.md

@@ -8,3 +8,8 @@ eleventyNavigation:
 ```
 ```
 {% include borgmatic/command-line/config-bootstrap.txt %}
 {% 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)

+ 5 - 0
docs/reference/command-line/actions/config-generate.md

@@ -8,3 +8,8 @@ eleventyNavigation:
 ```
 ```
 {% include borgmatic/command-line/config-generate.txt %}
 {% include borgmatic/command-line/config-generate.txt %}
 ```
 ```
+
+
+## Related documentation
+
+ * [Configuration](https://torsion.org/borgmatic/how-to/set-up-backups/#configuration)

+ 5 - 0
docs/reference/command-line/actions/config-validate.md

@@ -8,3 +8,8 @@ eleventyNavigation:
 ```
 ```
 {% include borgmatic/command-line/config-validate.txt %}
 {% include borgmatic/command-line/config-validate.txt %}
 ```
 ```
+
+
+## Related documentation
+
+ * [Validation](https://torsion.org/borgmatic/how-to/set-up-backups/#validation)

+ 5 - 0
docs/reference/command-line/actions/create.md

@@ -8,3 +8,8 @@ eleventyNavigation:
 ```
 ```
 {% include borgmatic/command-line/create.txt %}
 {% include borgmatic/command-line/create.txt %}
 ```
 ```
+
+
+## Related documentation
+
+ * [Backups](https://torsion.org/borgmatic/how-to/set-up-backups/#backups)

+ 5 - 0
docs/reference/command-line/actions/extract.md

@@ -8,3 +8,8 @@ eleventyNavigation:
 ```
 ```
 {% include borgmatic/command-line/extract.txt %}
 {% include borgmatic/command-line/extract.txt %}
 ```
 ```
+
+
+## Related documentation
+
+ * [How to extract a backup](https://torsion.org/borgmatic/how-to/extract-a-backup/)

+ 5 - 0
docs/reference/command-line/actions/info.md

@@ -8,3 +8,8 @@ eleventyNavigation:
 ```
 ```
 {% include borgmatic/command-line/info.txt %}
 {% include borgmatic/command-line/info.txt %}
 ```
 ```
+
+
+## Related documentation
+
+ * [How to inspect your backups](https://torsion.org/borgmatic/how-to/inspect-your-backups/)

+ 5 - 0
docs/reference/command-line/actions/list.md

@@ -8,3 +8,8 @@ eleventyNavigation:
 ```
 ```
 {% include borgmatic/command-line/list.txt %}
 {% include borgmatic/command-line/list.txt %}
 ```
 ```
+
+
+## Related documentation
+
+ * [How to inspect your backups](https://torsion.org/borgmatic/how-to/inspect-your-backups/)

+ 5 - 0
docs/reference/command-line/actions/mount.md

@@ -8,3 +8,8 @@ eleventyNavigation:
 ```
 ```
 {% include borgmatic/command-line/mount.txt %}
 {% include borgmatic/command-line/mount.txt %}
 ```
 ```
+
+
+## Related documentation
+
+ * [Mount a filesystem](https://torsion.org/borgmatic/how-to/extract-a-backup/#mount-a-filesystem)

+ 8 - 3
docs/reference/command-line/actions/repo-create.md

@@ -1,10 +1,15 @@
 ---
 ---
-title: transfer
+title: repo-create
 eleventyNavigation:
 eleventyNavigation:
-  key: transfer
+  key: repo-create
   parent: 🎬 Actions
   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)

+ 5 - 0
docs/reference/command-line/actions/repo-info.md

@@ -8,3 +8,8 @@ eleventyNavigation:
 ```
 ```
 {% include borgmatic/command-line/repo-info.txt %}
 {% include borgmatic/command-line/repo-info.txt %}
 ```
 ```
+
+
+## Related documentation
+
+ * [How to inspect your backups](https://torsion.org/borgmatic/how-to/inspect-your-backups/)

+ 5 - 0
docs/reference/command-line/actions/repo-list.md

@@ -8,3 +8,8 @@ eleventyNavigation:
 ```
 ```
 {% include borgmatic/command-line/repo-list.txt %}
 {% include borgmatic/command-line/repo-list.txt %}
 ```
 ```
+
+
+## Related documentation
+
+ * [How to inspect your backups](https://torsion.org/borgmatic/how-to/inspect-your-backups/)

+ 5 - 0
docs/reference/command-line/actions/restore.md

@@ -8,3 +8,8 @@ eleventyNavigation:
 ```
 ```
 {% include borgmatic/command-line/restore.txt %}
 {% include borgmatic/command-line/restore.txt %}
 ```
 ```
+
+
+## Related documentation
+
+ * [Database restoration](https://torsion.org/borgmatic/how-to/backup-your-databases/#database-restoration)

+ 4 - 0
docs/reference/command-line/actions/transfer.md

@@ -8,3 +8,7 @@ eleventyNavigation:
 ```
 ```
 {% include borgmatic/command-line/transfer.txt %}
 {% 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)

+ 5 - 0
docs/reference/command-line/actions/umount.md

@@ -8,3 +8,8 @@ eleventyNavigation:
 ```
 ```
 {% include borgmatic/command-line/umount.txt %}
 {% include borgmatic/command-line/umount.txt %}
 ```
 ```
+
+
+## Related documentation
+
+ * [Mount a filesystem](https://torsion.org/borgmatic/how-to/extract-a-backup/#mount-a-filesystem)