extern/zrepl
1
0
Fork 0
mirror of https://github.com/zrepl/zrepl.git synced 2024-11-25 01:44:43 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: switch back to patched up relref for links to section pages

Browse Source
This commit is contained in:
Christian Schwarz 2017-10-02 12:42:09 +02:00
parent 775bc5caf6
commit 164f77d80c
4 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/content/_index.md
View File

@ -11,7 +11,7 @@ Use & test at your own risk ;)
## Getting started
The [5 minute tutorial setup](/tutorial/) gives you a first impression.
The [5 minute tutorial setup]({{< relref "tutorial/_index.md" >}}) gives you a first impression.
## Main Features

2
docs/content/install/_index.md
View File

@ -45,7 +45,7 @@ zrepl searches for its main configuration file in the following locations (in th
Alternatively, use CLI flags to specify a config location.
Copy a config from the [tutorial](/tutorial) or the `cmd/sampleconf` directory to one of these locations and customize it to your setup.
Copy a config from the [tutorial]({{< relref "tutorial/_index.md" >}}) or the `cmd/sampleconf` directory to one of these locations and customize it to your setup.
## Runtime Directories

14
docs/content/tutorial/_index.md
View File

@ -44,11 +44,11 @@ a gap in our backup history.
## Install zrepl
Follow the [OS-specific installation instructions](/install/) and come back here.
Follow the [OS-specific installation instructions]({{< relref "install/_index.md" >}}) and come back here.
## Configure `backups`
We define a **pull job** named `pull_prod1` in the [main configuration file](/install/#main-configuration-file):
We define a **pull job** named `pull_prod1` in the [main configuration file]({{< relref "install/_index.md#configuration-files" >}} ):
```yaml
jobs:
@ -88,7 +88,7 @@ You can learn more about the [**pull job** format here]({{< relref "configuratio
## Configure `prod1`
We define a corresponding **source job** named `pull_backup` in the [main configuration file](/install/#main-configuration-file)
We define a corresponding **source job** named `pull_backup` in the [main configuration file]({{< relref "install/_index.md#configuration-files" >}})
`zrepl.yml`:
```yaml
@ -129,13 +129,13 @@ command="zrepl stdinserver backups.example.com",no-port-forwarding,no-X11-forwar
{{% alert theme="info" %}}The entries **must** be on a single line, including the replaced BACKUPS_SSH_PUBKEY{{% /alert %}}
Again, you can learn more about the [**source job** format here]({{< ref "configuration/jobs.md#source" >}}).
Again, you can learn more about the [**source job** format here]({{< relref "configuration/jobs.md#source" >}}).
## Apply Configuration Changes
We need to restart the zrepl daemon on **both** `prod1` and `backups`.
This is [OS-specific](/install/#restarting).
This is [OS-specific]({{< relref "install/_index.md#restarting" >}}).
## Watch it Work
@ -165,8 +165,8 @@ tmux select-layout tiled
Congratulations, you have a working pull backup. Where to go next?
* Read more about [configuration format, options & job types](/configuration/)
* Learn about [implementation details](/impl/) of zrepl.
* Read more about [configuration format, options & job types]({{< relref "configuration/_index.md" >}})
* Learn about [implementation details]({{<relref "impl/_index.md" >}}) of zrepl.

2
docs/themes/docdock vendored

@ -1 +1 @@
Subproject commit 9e429b2c209e6062e7bd6f53ced0a31d3b624448
Subproject commit 1e35d34235f01ada2fae96802510fd3937dfdb54