Skip to content

"rsync for cloud storage" - Google Drive, S3, Dropbox, Backblaze B2, One Drive, Swift, Hubic, Wasabi, Google Cloud Storage, Azure Blob, Azure Files, Yandex Files

docs: update making a new backend docs

Nick Craig-Wood67013ccf35a5
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a03b407f2..9bba0221f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -632,14 +632,22 @@ Add your backend to the docs - you'll need to pick an icon for it from
alphabetical order of full name of remote (e.g. `drive` is ordered as
`Google Drive`) but with the local file system last.
+First add a data file about your backend in
+`docs/data/backends/remote.yaml` - this is used to build the overview
+tables and the tiering info.
+
+- Create it with: `bin/manage_backends.py create docs/data/backends/remote.yaml`
+- Edit it to fill in the blanks. Look at the [tiers docs](https://rclone.org/tiers/).
+- Run this command to fill in the features: `bin/manage_backends.py features docs/data/backends/remote.yaml`
+
+Next edit these files:
+
- `README.md` - main GitHub page
- `docs/content/remote.md` - main docs page (note the backend options are
automatically added to this file with `make backenddocs`)
- make sure this has the `autogenerated options` comments in (see your
reference backend docs)
- update them in your backend with `bin/make_backend_docs.py remote`
-- `docs/content/overview.md` - overview docs - add an entry into the Features
- table and the Optional Features table.
- `docs/content/docs.md` - list of remotes in config section
- `docs/content/_index.md` - front page of rclone.org
- `docs/layouts/chrome/navbar.html` - add it to the website navigation