mirror of
https://github.com/zrepl/zrepl.git
synced 2025-04-10 19:38:16 +02:00
docs: improve welcome page
This commit is contained in:
parent
cd9bfbff6c
commit
d9064d46f6
@ -22,18 +22,24 @@ development. Some of the features below are not implemented yet. Use & test at y
|
|||||||
* compressed `send & receive`
|
* compressed `send & receive`
|
||||||
* raw encrypted `send & receive` (as soon as it is available)
|
* raw encrypted `send & receive` (as soon as it is available)
|
||||||
* access control checks when pulling datasets
|
* access control checks when pulling datasets
|
||||||
* flexible mappings for filesystems
|
* [flexible mappings]({{< ref "configuration/overview.md#mapping-filter-syntax" >}}) for filesystems
|
||||||
* automatic snapshot creation
|
* automatic snapshot creation
|
||||||
* periodic interval
|
* periodic interval
|
||||||
* automatic snapshot pruning
|
* automatic snapshot pruning
|
||||||
* *retention grid* TODO link explain
|
* [Retention Grid]({{< ref "configuration/snapshots.md#retention-grid" >}})
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
We are happy about contributors, both for the `zrepl` codebase and theses docs.
|
`zrepl` is usable but nowhere near a stable release right now - we are happy
|
||||||
Feel free to open a ticket or even submit a pull request ;)
|
about contributors!
|
||||||
|
|
||||||
|
* Explore the codebase
|
||||||
|
* These docs live in the `docs/` subdirectory
|
||||||
|
* Document non-obvious / confusing / plain broken things you encounter when using `zrepl` for the first time
|
||||||
|
* Check the *Issues* and *Projects* sections for things to do ;)
|
||||||
|
|
||||||
|
{{% panel header="<i class='fa fa-github'></i> Getting your code merged"%}}
|
||||||
|
[The <i class='fa fa-github'></i> GitHub repository](https://github.com/zrepl/zrepl) is where all development happens.
|
||||||
|
Open your issue / PR there.
|
||||||
|
{{% /panel %}}
|
||||||
|
|
||||||
* <i class='fa fa-github'></i> [zrepl GitHub repository](https://github.com/zrepl/zrepl)
|
|
||||||
* these docs:
|
|
||||||
* were started on 2017-08-08 and are not committed yet.
|
|
||||||
* please use GitHub flavored markdown and open an issue in the `zrepl` repo
|
|
||||||
|
@ -5,3 +5,5 @@ weight = 200
|
|||||||
+++
|
+++
|
||||||
|
|
||||||
{{% alert theme="warning"%}}TBD{{% /alert %}}
|
{{% alert theme="warning"%}}TBD{{% /alert %}}
|
||||||
|
|
||||||
|
## Retention Grid
|
||||||
|
Loading…
Reference in New Issue
Block a user