From d05fd2a14f67daa7b30d71e05af12ed2c8ad8138 Mon Sep 17 00:00:00 2001 From: albertony <12441419+albertony@users.noreply.github.com> Date: Sat, 19 Nov 2022 13:33:15 +0100 Subject: [PATCH] docs: add badge for experimental/beta/deprecated status next to version in backend docs --- docs/content/cache.md | 3 ++- docs/content/chunker.md | 3 ++- docs/content/compress.md | 3 ++- docs/content/hasher.md | 3 ++- docs/layouts/_default/baseof.html | 13 +++++++++++++ 5 files changed, 21 insertions(+), 4 deletions(-) diff --git a/docs/content/cache.md b/docs/content/cache.md index bd28b037b..9b787366e 100644 --- a/docs/content/cache.md +++ b/docs/content/cache.md @@ -2,9 +2,10 @@ title: "Cache" description: "Rclone docs for cache remote" versionIntroduced: "v1.39" +status: Deprecated --- -# {{< icon "fa fa-archive" >}} Cache (DEPRECATED) +# {{< icon "fa fa-archive" >}} Cache The `cache` remote wraps another existing remote and stores file structure and its data for long running tasks like `rclone mount`. diff --git a/docs/content/chunker.md b/docs/content/chunker.md index 4403ad5d3..931e9a5d8 100644 --- a/docs/content/chunker.md +++ b/docs/content/chunker.md @@ -2,9 +2,10 @@ title: "Chunker" description: "Split-chunking overlay remote" versionIntroduced: "v1.50.0" +status: Beta --- -# {{< icon "fa fa-cut" >}} Chunker (EXPERIMENTAL) +# {{< icon "fa fa-cut" >}} Chunker The `chunker` overlay transparently splits large files into smaller chunks during upload to wrapped remote and transparently assembles them back diff --git a/docs/content/compress.md b/docs/content/compress.md index 7ee03a25a..27343236c 100644 --- a/docs/content/compress.md +++ b/docs/content/compress.md @@ -2,9 +2,10 @@ title: "Compress" description: "Compression Remote" versionIntroduced: "v1.54.0" +status: Experimental --- -# {{< icon "fas fa-compress" >}} Compress (EXPERIMENTAL) +# {{< icon "fas fa-compress" >}} Compress ## Warning diff --git a/docs/content/hasher.md b/docs/content/hasher.md index aa492d3a7..b52fb3bc9 100644 --- a/docs/content/hasher.md +++ b/docs/content/hasher.md @@ -2,9 +2,10 @@ title: "Hasher" description: "Better checksums for other remotes" versionIntroduced: "v1.57.0" +status: Experimental --- -# {{< icon "fa fa-check-double" >}} Hasher (EXPERIMENTAL) +# {{< icon "fa fa-check-double" >}} Hasher Hasher is a special overlay backend to create remotes which handle checksums for other remotes. It's main functions include: diff --git a/docs/layouts/_default/baseof.html b/docs/layouts/_default/baseof.html index 6598c2f8c..e84ba3f29 100644 --- a/docs/layouts/_default/baseof.html +++ b/docs/layouts/_default/baseof.html @@ -26,7 +26,20 @@
+ {{ $statusMap := dict + "deprecated" "This feature is currently deprecated." + "experimental" "This feature is currently experimental and any use is at your own risk." + "beta" "This feature is currently in beta must be used with care." + }} + {{ if .Params.versionIntroduced }}{{ .Params.versionIntroduced }}{{ end }} + + {{ with .Params.status | lower }} + {{ $statusCode := . }} + {{ $statusMessage := index $statusMap $statusCode }} + {{ $statusCode }} + {{ end }} + {{ block "main" . }} {{ end }}