diff --git a/docs/content/_index.md b/docs/content/_index.md index 627a96f..3245737 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -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 diff --git a/docs/content/install/_index.md b/docs/content/install/_index.md index df48cbd..1e74713 100644 --- a/docs/content/install/_index.md +++ b/docs/content/install/_index.md @@ -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 @@ -82,4 +82,4 @@ The daemon handles SIGINT and SIGTERM for graceful shutdown. Graceful shutdown means at worst that a job will not be rescheduled for the next interval. -The daemon exits as soon as all jobs have reported shut down. \ No newline at end of file +The daemon exits as soon as all jobs have reported shut down. diff --git a/docs/content/tutorial/_index.md b/docs/content/tutorial/_index.md index 7b790c8..4f8f62d 100644 --- a/docs/content/tutorial/_index.md +++ b/docs/content/tutorial/_index.md @@ -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]({{}}) of zrepl. diff --git a/docs/themes/docdock b/docs/themes/docdock index 9e429b2..1e35d34 160000 --- a/docs/themes/docdock +++ b/docs/themes/docdock @@ -1 +1 @@ -Subproject commit 9e429b2c209e6062e7bd6f53ced0a31d3b624448 +Subproject commit 1e35d34235f01ada2fae96802510fd3937dfdb54