extern/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2025-04-01 10:56:18 +02:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/content/cache.md
View File

@ -2,9 +2,10 @@
title: "Cache" title: "Cache"
description: "Rclone docs for cache remote" description: "Rclone docs for cache remote"
versionIntroduced: "v1.39" 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 The `cache` remote wraps another existing remote and stores file structure
and its data for long running tasks like `rclone mount`. and its data for long running tasks like `rclone mount`.

3
docs/content/chunker.md
View File

@ -2,9 +2,10 @@
title: "Chunker" title: "Chunker"
description: "Split-chunking overlay remote" description: "Split-chunking overlay remote"
versionIntroduced: "v1.50.0" 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 The `chunker` overlay transparently splits large files into smaller chunks
during upload to wrapped remote and transparently assembles them back during upload to wrapped remote and transparently assembles them back

3
docs/content/compress.md
View File

@ -2,9 +2,10 @@
title: "Compress" title: "Compress"
description: "Compression Remote" description: "Compression Remote"
versionIntroduced: "v1.54.0" versionIntroduced: "v1.54.0"
status: Experimental
--- ---
# {{< icon "fas fa-compress" >}} Compress (EXPERIMENTAL) # {{< icon "fas fa-compress" >}} Compress
## Warning ## Warning

3
docs/content/hasher.md
View File

@ -2,9 +2,10 @@
title: "Hasher" title: "Hasher"
description: "Better checksums for other remotes" description: "Better checksums for other remotes"
versionIntroduced: "v1.57.0" 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 Hasher is a special overlay backend to create remotes which handle
checksums for other remotes. It's main functions include: checksums for other remotes. It's main functions include:

13
docs/layouts/_default/baseof.html
View File

@ -26,7 +26,20 @@
<div class="container-fluid"> <div class="container-fluid">
<div class="row"> <div class="row">
<div class="col-md-9"> <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 }} {{ 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" . }} {{ block "main" . }}
{{ end }} {{ end }}
</div> </div>