"rsync for cloud storage" - Google Drive, S3, Dropbox, Backblaze B2, One Drive, Swift, Hubic, Wasabi, Google Cloud Storage, Azure Blob, Azure Files, Yandex Files
Go azure-blobazure-blob-storageazure-filesbackblaze-b2cloud-storagedropboxencryptionftpfuse-filesystemgogolanggoogle-cloud-storagegoogle-driveonedriveopenstack-swiftrclones3sftpsyncwebdav
docs: add tiering to the documentation - fixes #8873
Nick Craig-Wood58f30ab538d0
diff --git a/docs/content/amazonclouddrive.md b/docs/content/amazonclouddrive.mdindex 8f9de1da1..26437989e 100644--- a/docs/content/amazonclouddrive.md+++ b/docs/content/amazonclouddrive.md@@ -2,7 +2,7 @@title: "Amazon Drive"description: "Rclone docs for Amazon Drive"versionIntroduced: "v1.20"-status: Deprecated+status: Removed---# {{< icon "fab fa-amazon" >}} Amazon Drivediff --git a/docs/content/cache.md b/docs/content/cache.mdindex d3f1d865e..ee1166123 100644--- a/docs/content/cache.md+++ b/docs/content/cache.md@@ -2,7 +2,6 @@title: "Cache"description: "Rclone docs for cache remote"versionIntroduced: "v1.39"-status: Deprecated---# {{< icon "fa fa-archive" >}} Cache@@ -10,6 +9,9 @@ status: DeprecatedThe `cache` remote wraps another existing remote and stores file structureand its data for long running tasks like `rclone mount`.+It is **deprecated** so not recommended for use with new installations+and may be removed at some point.+## StatusThe cache backend code is working but it currently doesn'tdiff --git a/docs/content/chunker.md b/docs/content/chunker.mdindex 57cf1ce8d..8418e97b2 100644--- a/docs/content/chunker.md+++ b/docs/content/chunker.md@@ -2,7 +2,6 @@title: "Chunker"description: "Split-chunking overlay remote"versionIntroduced: "v1.50"-status: Beta---# {{< icon "fa fa-cut" >}} Chunkerdiff --git a/docs/content/compress.md b/docs/content/compress.mdindex 0d854bedd..58b0d0c47 100644--- a/docs/content/compress.md+++ b/docs/content/compress.md@@ -2,7 +2,6 @@title: "Compress"description: "Compression Remote"versionIntroduced: "v1.54"-status: Experimental---# {{< icon "fas fa-compress" >}} Compressdiff --git a/docs/content/hasher.md b/docs/content/hasher.mdindex ed5c933e0..fd38b6c14 100644--- a/docs/content/hasher.md+++ b/docs/content/hasher.md@@ -2,7 +2,6 @@title: "Hasher"description: "Better checksums for other remotes"versionIntroduced: "v1.57"-status: Experimental---# {{< icon "fa fa-check-double" >}} Hasherdiff --git a/docs/content/iclouddrive.md b/docs/content/iclouddrive.mdindex 3ec62ede0..393660a58 100644--- a/docs/content/iclouddrive.md+++ b/docs/content/iclouddrive.md@@ -2,7 +2,6 @@title: "iCloud Drive"description: "Rclone docs for iCloud Drive"versionIntroduced: "v1.69"-status: Beta---# {{< icon "fa fa-cloud" >}} iCloud Drivediff --git a/docs/content/protondrive.md b/docs/content/protondrive.mdindex 107f960fd..8163781ee 100644--- a/docs/content/protondrive.md+++ b/docs/content/protondrive.md@@ -2,7 +2,6 @@title: "Proton Drive"description: "Rclone docs for Proton Drive"versionIntroduced: "v1.64.0"-status: Beta---# {{< icon "fa fa-folder" >}} Proton Drivediff --git a/docs/content/tiers.md b/docs/content/tiers.mdnew file mode 100644index 000000000..d00b05f63--- /dev/null+++ b/docs/content/tiers.md@@ -0,0 +1,58 @@+---+title: "Backend Support Tiers"+description: "A complete list of supported backends and their stability tiers."+---++# Tiers++Rclone backends are divided into tiers to give users an idea of the stability of each backend.++| Tier | Label | Intended meaning |+|--------|---------------|------------------|+| {{< tier tier="Tier 1" >}} | Core | Production-grade, first-class |+| {{< tier tier="Tier 2" >}} | Stable | Well-supported, minor gaps |+| {{< tier tier="Tier 3" >}} | Supported | Works for many uses; known caveats |+| {{< tier tier="Tier 4" >}} | Experimental | Use with care; expect gaps/changes |+| {{< tier tier="Tier 5" >}} | Deprecated | No longer maintained or supported |++## Overview++Here is a summary of all backends:++{{< tiers-table >}}++## Scoring++Here is how the backends are scored.++### Features++These are useful optional features a backend should have in rough+order of importance. Each one of these scores a point for the Features+column.++- F1: Hash(es)+- F2: Modtime+- F3: Stream upload+- F4: Copy/Move+- F5: DirMove+- F6: Metadata+- F7: MultipartUpload+++### Tier++The tier is decided after determining these attributes. Some discretion is allowed in tiering as some of these attributes are more important than others.++| Attr | T1: Core | T2: Stable | T3: Supported | T4: Experimental | T5: Incubator |+|------|----------|------------|---------------|------------------|---------------|+| Maintainers | >=2 | >=1 | >=1 | >=0 | >=0 |+| API source | Official | Official | Either | Either | Either |+| Features (F1-F7) | >=5/7 | >=4/7 | >=3/7 | >=2/7 | N/A |+| Integration tests | All Green | All green | Nearly all green | Some Flaky | N/A |+| Error handling | Pacer | Pacer | Retries | Retries | N/A |+| Data integrity | Hashes, alt, modtime | Hashes or alt | Hash OR modtime | Best-effort | N/A |+| Perf baseline | Bench within 2x S3 | Bench doc | Anecdotal OK | Optional | N/A |+| Adoption | widely used | often used | some use | N/A | N/A |+| Docs completeness | Full | Full | Basic | Minimal | Minimal |+| Security | Principle-of-least-privilege | Reasonable scopes | Basic auth | Works | Works |diff --git a/docs/layouts/_default/baseof.html b/docs/layouts/_default/baseof.htmlindex 326e826c4..02f332eae 100644--- a/docs/layouts/_default/baseof.html+++ b/docs/layouts/_default/baseof.html@@ -41,7 +41,12 @@{{ 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>+ <span class="badge badge-pill badge-danger float-right" style="margin-top: 30px; font-size: 100%" title="{{ $statusMessage }}">{{ $statusCode | title }}</span>+ {{ end }}++ {{ if .Page.File }}+ {{ $backendName := .Page.File.TranslationBaseName }}+ {{ partial "tier.html" (dict "name" $backendName "align" true) }}{{ end }}{{ block "main" . }}diff --git a/docs/layouts/chrome/navbar.html b/docs/layouts/chrome/navbar.htmlindex e9def50e7..e1eecb235 100644--- a/docs/layouts/chrome/navbar.html+++ b/docs/layouts/chrome/navbar.html@@ -51,6 +51,7 @@</a><div class="dropdown-menu pre-scrollable" aria-labelledby="navbarDropdown"><a class="dropdown-item" href="/overview/"><i class="fas fa-map fa-fw"></i> Overview</a>+ <a class="dropdown-item" href="/tiers/"><i class="fas fa-map fa-fw"></i> Support Tiers</a><div class="dropdown-divider"></div><a class="dropdown-item" href="/fichier/"><i class="fa fa-archive fa-fw"></i> 1Fichier</a><a class="dropdown-item" href="/netstorage/"><i class="fas fa-database fa-fw"></i> Akamai NetStorage</a>diff --git a/docs/layouts/partials/tier.html b/docs/layouts/partials/tier.htmlnew file mode 100644index 000000000..07f38883a--- /dev/null+++ b/docs/layouts/partials/tier.html@@ -0,0 +1,42 @@+{{/* Context: Accepts .tier (string) OR .name (string) for lookup. Optional: .align (bool) */}}++{{ $tierColors := dict+ "Tier 1" "success"+ "Tier 2" "success"+ "Tier 3" "warning"+ "Tier 4" "danger"+ "Tier 5" "danger"+}}++{{ $tierMessages := dict+ "Tier 1" "Core: Production-grade, first-class"+ "Tier 2" "Stable: Well-supported, minor gaps"+ "Tier 3" "Supported: Works for many uses; known caveats"+ "Tier 4" "Experimental: Use with care; expect gaps/changes"+ "Tier 5" "Deprecated: No longer maintained or supported"+}}++{{/* Determine the Tier Name */}}+{{ $currentTier := "" }}++{{ if .tier }}+ {{/* Direct Tier Usage */}}+ {{ $currentTier = .tier }}+{{ else if .name }}+ {{/* Backend Lookup Usage */}}+ {{ $backendName := .name | lower }}+ {{ $data := index site.Data.backends $backendName }}+ {{ if $data }}+ {{ $currentTier = $data.tier }}+ {{ end }}+{{ end }}++{{/* Render Badge if a Tier was found */}}+{{ if $currentTier }}+ {{ $color := index $tierColors $currentTier | default "secondary" }}+ {{ $message := index $tierMessages $currentTier | default "" }}++ <a href="/tiers/" class="badge badge-pill badge-{{ $color }} {{ if .align }}float-right{{ end }}" style="{{ if .align }}margin-top: 30px; {{ end }}font-size: 100%" title="{{ $message }}">+ {{ $currentTier }}+ </a>+{{ end }}diff --git a/docs/layouts/shortcodes/tier.html b/docs/layouts/shortcodes/tier.htmlnew file mode 100644index 000000000..13fcbbe4f--- /dev/null+++ b/docs/layouts/shortcodes/tier.html@@ -0,0 +1 @@+{{ partial "tier.html" (dict "tier" (.Get "tier") "name" (.Get "name") "align" (.Get "align")) }}diff --git a/docs/layouts/shortcodes/tiers-table.html b/docs/layouts/shortcodes/tiers-table.htmlnew file mode 100644index 000000000..8597b3363--- /dev/null+++ b/docs/layouts/shortcodes/tiers-table.html@@ -0,0 +1,41 @@+<table>+ <thead>+ <tr>+ <th>Backend</th>+ <th>Tier</th>+ <th>Maintainers</th>+ <th>Features</th>+ <th>Tests</th>+ <th>Integrity</th>+ <th>Perf</th>+ <th>Adoption</th>+ <th>Docs</th>+ <th>Security</th>+ </tr>+ </thead>+ <tbody>+ {{ range $name, $data := site.Data.backends }}+ <tr>+ <td style="font-weight: bold;">+ <a href="/{{ $name | urlize }}">{{ $data.name }}</a>+ </td>+ <td>+ {{ partial "tier.html" (dict "name" $name "align" false) }}+ </td>+ <td>{{ $data.maintainers | default "-" }}</td>+ <td>{{ $data.features_score | string | default "-" }}</td>+ <td>+ <span class="{{ if eq $data.integration_tests "Passing" }}text-success{{ else }}text-danger{{ end }}">+ {{ if eq $data.integration_tests "Passing" }}✔{{ else }}✖{{ end }}+ </span>+ {{ $data.integration_tests | default "-" }}+ </td>+ <td>{{ $data.data_integrity | default "-" }}</td>+ <td>{{ $data.performance | default "-" }}</td>+ <td>{{ $data.adoption | default "-" }}</td>+ <td>{{ $data.docs | default "-" }}</td>+ <td>{{ $data.security | default "-" }}</td>+ </tr>+ {{ end }}+ </tbody>+</table>