extern/zrepl
1
0
Fork 0
mirror of https://github.com/zrepl/zrepl.git synced 2024-12-23 07:28:57 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: update front page with new features & refs

Browse Source
This commit is contained in:
Christian Schwarz 2017-10-03 16:07:21 +02:00
parent 678b4a6f4b
commit 2764c95952
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/content/_index.md
View File

@ -6,6 +6,7 @@ title = "zrepl - ZFS replication"
{{% notice info %}} {{% notice info %}}
zrepl as well as this documentation is still under active development. 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 ;) Use & test at your own risk ;)
{{% /notice %}} {{% /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) * Raw encrypted `send & receive` (as soon as it is available)
* Automatic snapshot creation * Automatic snapshot creation
* [x] Ensure fixed time interval between snapshots * [x] Ensure fixed time interval between snapshots
* Automatic snapshot pruning * Automatic snapshot [pruning]({{< ref "configuration/prune.md" >}})
* [x] <i class="fa fa-arrow-right" aria-hidden="true"></i> [Retention Grid]({{< ref "configuration/prune.md#retention-grid" >}}) * [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 * Maintainable implementation in Go
* [x] Cross platform * [x] Cross platform
* [x] Type safe & testable code * [x] Type safe & testable code
* Flexible, detailed & structured [logging]({{< ref "configuration/logging.md" >}})
## Contributing ## 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 * Explore the codebase
* These docs live in the `docs/` subdirectory * 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 * 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 * Check the *Issues* and *Projects* sections for things to do
{{% panel header="<i class='fa fa-github'></i> Getting your code merged"%}} {{% panel header="<i class='fa fa-github'></i> Development Workflow"%}}
[The <i class='fa fa-github'></i> GitHub repository](https://github.com/zrepl/zrepl) is where all development happens. [The <i class='fa fa-github'></i> GitHub repository](https://github.com/zrepl/zrepl) is where all development happens.<br />
Open your issue / PR there. Make sure to read the [Developer Documentation section](https://github.com/zrepl/zrepl) and open new issues or pull requests there.
{{% /panel %}} {{% /panel %}}