docs: add badge for experimental/beta/deprecated status next to version in backend docs

This commit is contained in:
albertony 2022-11-19 13:33:15 +01:00
parent 097be753ab
commit d05fd2a14f
5 changed files with 21 additions and 4 deletions

View File

@ -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`.

View File

@ -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

View File

@ -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

View File

@ -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:

View File

@ -26,7 +26,20 @@
<div class="container-fluid">
<div class="row">
<div class="col-md-9">
{{ $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 }}<span class="badge badge-pill badge-secondary float-right" style="margin-top: 30px; font-size: 100%" title="This feature needs Rclone {{ .Params.versionIntroduced }} or later.">{{ .Params.versionIntroduced }}</span>{{ end }}
{{ with .Params.status | lower }}
{{ $statusCode := . }}
{{ $statusMessage := index $statusMap $statusCode }}
<span class="badge badge-pill badge-danger float-right" style="margin-top: 30px; font-size: 100%" title="{{ $statusMessage }}">{{ $statusCode }}</span>
{{ end }}
{{ block "main" . }}
{{ end }}
</div>