From 1e7144eb630a4e64620645d8462e6c97057bc0d9 Mon Sep 17 00:00:00 2001 From: Nick Craig-Wood <nick@craig-wood.com> Date: Mon, 30 Sep 2019 12:26:33 +0100 Subject: [PATCH] docs: Add more notes on making backend docs --- CONTRIBUTING.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f5db2d11c..d7c9ecd9e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -367,16 +367,24 @@ Or if you want to run the integration tests manually: See the [testing](#testing) section for more information on integration tests. -Add your fs to the docs - you'll need to pick an icon for it from [fontawesome](http://fontawesome.io/icons/). Keep lists of remotes in alphabetical order but with the local file system last. +Add your fs to the docs - you'll need to pick an icon for it from +[fontawesome](http://fontawesome.io/icons/). Keep lists of remotes in +alphabetical order of full name of remote (eg `drive` is ordered as +`Google Drive`) but with the local file system last. * `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 with `make backenddocs` - revert any changes in other backends * `docs/content/overview.md` - overview docs * `docs/content/docs.md` - list of remotes in config section * `docs/content/about.md` - front page of rclone.org * `docs/layouts/chrome/navbar.html` - add it to the website navigation * `bin/make_manual.py` - add the page to the `docs` constant +Once you've written the docs, run `make serve` and check they look OK +in the web browser and the links (internal and external) all work. + ## Writing a plugin ## New features (backends, commands) can also be added "out-of-tree", through Go plugins.