From 2764c95952039da689699f27593d232496206900 Mon Sep 17 00:00:00 2001 From: Christian Schwarz Date: Tue, 3 Oct 2017 16:07:21 +0200 Subject: [PATCH] docs: update front page with new features & refs --- docs/content/_index.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/content/_index.md b/docs/content/_index.md index ef727c2..b54975f 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -6,6 +6,7 @@ title = "zrepl - ZFS replication" {{% notice info %}} zrepl as well as this documentation is still under active development. +It is neither feature complete nor is there a stability guarantee on the configuration format. Use & test at your own risk ;) {{% /notice %}} @@ -28,24 +29,26 @@ The [5 minute tutorial setup]({{< relref "tutorial/_index.md" >}}) gives you a f * Raw encrypted `send & receive` (as soon as it is available) * Automatic snapshot creation * [x] Ensure fixed time interval between snapshots -* Automatic snapshot pruning - * [x] [Retention Grid]({{< ref "configuration/prune.md#retention-grid" >}}) +* Automatic snapshot [pruning]({{< ref "configuration/prune.md" >}}) + * [x] Age-based fading (grandfathering scheme) +* Flexible, detailed & structured [logging]({{< ref "configuration/logging.md" >}}) + * [x] `human`, `logfmt` and `json` formatting + * [x] stdout, syslog and TCP (+TLS client auth) outlets * Maintainable implementation in Go * [x] Cross platform * [x] Type safe & testable code -* Flexible, detailed & structured [logging]({{< ref "configuration/logging.md" >}}) ## Contributing -zrepl is usable but nowhere near a stable release right now - we are happy about contributors! +We are happy about any help we can get! * Explore the codebase * These docs live in the `docs/` subdirectory * Document any non-obvious / confusing / plain broken behavior you encounter when setting up zrepl for the first time * Check the *Issues* and *Projects* sections for things to do -{{% panel header=" Getting your code merged"%}} -[The GitHub repository](https://github.com/zrepl/zrepl) is where all development happens. -Open your issue / PR there. +{{% panel header=" Development Workflow"%}} +[The GitHub repository](https://github.com/zrepl/zrepl) is where all development happens.
+Make sure to read the [Developer Documentation section](https://github.com/zrepl/zrepl) and open new issues or pull requests there. {{% /panel %}}