extern/zrepl
1
0
Fork 0
mirror of https://github.com/zrepl/zrepl.git synced 2025-06-20 01:37:45 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: fixup index site

Browse Source
This commit is contained in:
Christian Schwarz 2017-11-10 14:31:04 +01:00
parent 7ba5c14679
commit 36d2cb115a
1 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/index.rst
View File

@ -3,6 +3,8 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
.. include:: global.rst.inc
zrepl - ZFS replication zrepl - ZFS replication
----------------------- -----------------------
@ -25,7 +27,7 @@ Main Features
* [x] Pull mode * [x] Pull mode
* [ ] Push mode * [ ] Push mode
* [x] Access control checks when pulling datasets * [x] Access control checks when pulling datasets
* [x] [Flexible mapping]({{< ref "configuration/map_filter_syntax.md" >}}) rules * [x] :ref:`Flexible mapping <pattern-mapping>` rules
* [x] Bookmarks support * [x] Bookmarks support
* [ ] Feature-negotiation for * [ ] Feature-negotiation for
@ -37,13 +39,13 @@ Main Features
* [x] Ensure fixed time interval between snapshots * [x] Ensure fixed time interval between snapshots
* Automatic snapshot [pruning]({{< ref "configuration/prune.md" >}}) * Automatic snapshot :ref:`pruning <prune>`
* [x] Age-based fading (grandfathering scheme) * [x] Age-based fading (grandfathering scheme)
* Flexible, detailed & structured [logging]({{< ref "configuration/logging.md" >}}) * Flexible, detailed & structured :ref:`logging <logging>`
* [x] `human`, `logfmt` and `json` formatting * [x] ``human``, ``logfmt`` and ``json`` formatting
* [x] stdout, syslog and TCP (+TLS client auth) outlets * [x] stdout, syslog and TCP (+TLS client auth) outlets
* Maintainable implementation in Go * Maintainable implementation in Go
@ -57,14 +59,18 @@ Contributing
We are happy about any help we can get! 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> Development Workflow"%}} .. admonition:: Development Workflow
[The <i class='fa fa-github'></i> GitHub repository](https://github.com/zrepl/zrepl) is where all development happens.<br /> :class: note
Make sure to read the [Developer Documentation section](https://github.com/zrepl/zrepl) and open new issues or pull requests there.
{{% /panel %}} 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.
Table of Contents Table of Contents
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~