From a39a5d261cc803e9fadc927eb3c86d2939dc3b25 Mon Sep 17 00:00:00 2001 From: buengese Date: Sun, 17 Jan 2021 02:31:30 +0100 Subject: [PATCH] docs/compress: but a warning at the top --- docs/content/compress.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/content/compress.md b/docs/content/compress.md index 0050ffc24..fde2f4341 100644 --- a/docs/content/compress.md +++ b/docs/content/compress.md @@ -6,11 +6,14 @@ description: "Compression Remote" {{< icon "fas fa-compress" >}}Compress (Experimental) ----------------------------------------- +### Warning +This remote is currently **experimental**. Things may break and data may be lost. Anything you do with this remote is +at your own risk. Please understand the risks associated with using experimental code and don't use this remote in +critical applications. + The `Compress` remote adds compression to another remote. It is best used with remotes containing many large compressible files. -Please read the [warnings](#warnings) before using this remote. - To use this remote, all you need to do is specify another remote and a compression mode to use: ``` @@ -80,11 +83,6 @@ correct metadata files will not be recognized by rclone. The compressed files will be named `*.###########.gz` where `*` is the base file and the `#` part is base64 encoded size of the uncompressed file. The file names should not be changed by anything other than the rclone compression backend. -#### Experimental -This remote is currently **experimental**. Things may break and data may be lost. Anything you do with this remote is -at your own risk. Please understand the risks associated with using experimental code and don't use this remote in -critical applications. - {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/compress/compress.go then run make backenddocs" >}} ### Standard Options