gendocs: add autogenerated header to all docs

yanel · Feb 10, 2020 · dfb710e · dfb710e
1 parent 25cfeb2
commit dfb710e
Show file tree

Hide file tree

Showing 70 changed files with 140 additions and 69 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -148,6 +148,7 @@ with modules beneath.
     * ...commands
   * docs - the documentation and website
     * content - adjust these docs only - everything else is autogenerated
+      * command - these are auto generated - edit the corresponding .go file
   * fs - main rclone definitions - minimal amount of code
     * accounting - bandwidth limiting and statistics
     * asyncreader - an io.Reader which reads ahead

diff --git a/cmd/gendocs/gendocs.go b/cmd/gendocs/gendocs.go
@@ -25,6 +25,7 @@ date: %s
 title: "%s"
 slug: %s
 url: %s
+# autogenerated - DO NOT EDIT, instead edit the source code in %s and as part of making a release run "make commanddocs"
 ---
 `
 
@@ -67,7 +68,8 @@ rclone.org website.`,
 			name := filepath.Base(filename)
 			base := strings.TrimSuffix(name, path.Ext(name))
 			url := "/commands/" + strings.ToLower(base) + "/"
-			return fmt.Sprintf(gendocFrontmatterTemplate, now, strings.Replace(base, "_", " ", -1), base, url)
+			source := strings.Replace(strings.Replace(base, "rclone", "cmd", -1), "_", "/", -1) + "/"
+			return fmt.Sprintf(gendocFrontmatterTemplate, now, strings.Replace(base, "_", " ", -1), base, url, source)
 		}
 		linkHandler := func(name string) string {
 			base := strings.TrimSuffix(name, path.Ext(name))

diff --git a/docs/content/commands/rclone.md b/docs/content/commands/rclone.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone"
 slug: rclone
 url: /commands/rclone/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/ and as part of making a release run "make commanddocs"
 ---
 ## rclone
 

diff --git a/docs/content/commands/rclone_about.md b/docs/content/commands/rclone_about.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone about"
 slug: rclone_about
 url: /commands/rclone_about/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/about/ and as part of making a release run "make commanddocs"
 ---
 ## rclone about
 

diff --git a/docs/content/commands/rclone_authorize.md b/docs/content/commands/rclone_authorize.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone authorize"
 slug: rclone_authorize
 url: /commands/rclone_authorize/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/authorize/ and as part of making a release run "make commanddocs"
 ---
 ## rclone authorize
 

diff --git a/docs/content/commands/rclone_cachestats.md b/docs/content/commands/rclone_cachestats.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone cachestats"
 slug: rclone_cachestats
 url: /commands/rclone_cachestats/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/cachestats/ and as part of making a release run "make commanddocs"
 ---
 ## rclone cachestats
 

diff --git a/docs/content/commands/rclone_cat.md b/docs/content/commands/rclone_cat.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone cat"
 slug: rclone_cat
 url: /commands/rclone_cat/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/cat/ and as part of making a release run "make commanddocs"
 ---
 ## rclone cat
 

diff --git a/docs/content/commands/rclone_check.md b/docs/content/commands/rclone_check.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone check"
 slug: rclone_check
 url: /commands/rclone_check/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/check/ and as part of making a release run "make commanddocs"
 ---
 ## rclone check
 

diff --git a/docs/content/commands/rclone_cleanup.md b/docs/content/commands/rclone_cleanup.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone cleanup"
 slug: rclone_cleanup
 url: /commands/rclone_cleanup/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/cleanup/ and as part of making a release run "make commanddocs"
 ---
 ## rclone cleanup
 

diff --git a/docs/content/commands/rclone_config.md b/docs/content/commands/rclone_config.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone config"
 slug: rclone_config
 url: /commands/rclone_config/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/ and as part of making a release run "make commanddocs"
 ---
 ## rclone config
 

diff --git a/docs/content/commands/rclone_config_create.md b/docs/content/commands/rclone_config_create.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone config create"
 slug: rclone_config_create
 url: /commands/rclone_config_create/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/create/ and as part of making a release run "make commanddocs"
 ---
 ## rclone config create
 

diff --git a/docs/content/commands/rclone_config_delete.md b/docs/content/commands/rclone_config_delete.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone config delete"
 slug: rclone_config_delete
 url: /commands/rclone_config_delete/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/delete/ and as part of making a release run "make commanddocs"
 ---
 ## rclone config delete
 

diff --git a/docs/content/commands/rclone_config_disconnect.md b/docs/content/commands/rclone_config_disconnect.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone config disconnect"
 slug: rclone_config_disconnect
 url: /commands/rclone_config_disconnect/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/disconnect/ and as part of making a release run "make commanddocs"
 ---
 ## rclone config disconnect
 

diff --git a/docs/content/commands/rclone_config_dump.md b/docs/content/commands/rclone_config_dump.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone config dump"
 slug: rclone_config_dump
 url: /commands/rclone_config_dump/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/dump/ and as part of making a release run "make commanddocs"
 ---
 ## rclone config dump
 

diff --git a/docs/content/commands/rclone_config_edit.md b/docs/content/commands/rclone_config_edit.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone config edit"
 slug: rclone_config_edit
 url: /commands/rclone_config_edit/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/edit/ and as part of making a release run "make commanddocs"
 ---
 ## rclone config edit
 

diff --git a/docs/content/commands/rclone_config_file.md b/docs/content/commands/rclone_config_file.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone config file"
 slug: rclone_config_file
 url: /commands/rclone_config_file/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/file/ and as part of making a release run "make commanddocs"
 ---
 ## rclone config file
 

diff --git a/docs/content/commands/rclone_config_password.md b/docs/content/commands/rclone_config_password.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone config password"
 slug: rclone_config_password
 url: /commands/rclone_config_password/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/password/ and as part of making a release run "make commanddocs"
 ---
 ## rclone config password
 

diff --git a/docs/content/commands/rclone_config_providers.md b/docs/content/commands/rclone_config_providers.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone config providers"
 slug: rclone_config_providers
 url: /commands/rclone_config_providers/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/providers/ and as part of making a release run "make commanddocs"
 ---
 ## rclone config providers
 

diff --git a/docs/content/commands/rclone_config_reconnect.md b/docs/content/commands/rclone_config_reconnect.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone config reconnect"
 slug: rclone_config_reconnect
 url: /commands/rclone_config_reconnect/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/reconnect/ and as part of making a release run "make commanddocs"
 ---
 ## rclone config reconnect
 

diff --git a/docs/content/commands/rclone_config_show.md b/docs/content/commands/rclone_config_show.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone config show"
 slug: rclone_config_show
 url: /commands/rclone_config_show/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/show/ and as part of making a release run "make commanddocs"
 ---
 ## rclone config show
 

diff --git a/docs/content/commands/rclone_config_update.md b/docs/content/commands/rclone_config_update.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone config update"
 slug: rclone_config_update
 url: /commands/rclone_config_update/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/update/ and as part of making a release run "make commanddocs"
 ---
 ## rclone config update
 

diff --git a/docs/content/commands/rclone_config_userinfo.md b/docs/content/commands/rclone_config_userinfo.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone config userinfo"
 slug: rclone_config_userinfo
 url: /commands/rclone_config_userinfo/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/userinfo/ and as part of making a release run "make commanddocs"
 ---
 ## rclone config userinfo
 

diff --git a/docs/content/commands/rclone_copy.md b/docs/content/commands/rclone_copy.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone copy"
 slug: rclone_copy
 url: /commands/rclone_copy/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/copy/ and as part of making a release run "make commanddocs"
 ---
 ## rclone copy
 

diff --git a/docs/content/commands/rclone_copyto.md b/docs/content/commands/rclone_copyto.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone copyto"
 slug: rclone_copyto
 url: /commands/rclone_copyto/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/copyto/ and as part of making a release run "make commanddocs"
 ---
 ## rclone copyto
 

diff --git a/docs/content/commands/rclone_copyurl.md b/docs/content/commands/rclone_copyurl.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone copyurl"
 slug: rclone_copyurl
 url: /commands/rclone_copyurl/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/copyurl/ and as part of making a release run "make commanddocs"
 ---
 ## rclone copyurl
 

diff --git a/docs/content/commands/rclone_cryptcheck.md b/docs/content/commands/rclone_cryptcheck.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone cryptcheck"
 slug: rclone_cryptcheck
 url: /commands/rclone_cryptcheck/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/cryptcheck/ and as part of making a release run "make commanddocs"
 ---
 ## rclone cryptcheck
 

diff --git a/docs/content/commands/rclone_cryptdecode.md b/docs/content/commands/rclone_cryptdecode.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone cryptdecode"
 slug: rclone_cryptdecode
 url: /commands/rclone_cryptdecode/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/cryptdecode/ and as part of making a release run "make commanddocs"
 ---
 ## rclone cryptdecode
 

diff --git a/docs/content/commands/rclone_dbhashsum.md b/docs/content/commands/rclone_dbhashsum.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone dbhashsum"
 slug: rclone_dbhashsum
 url: /commands/rclone_dbhashsum/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/dbhashsum/ and as part of making a release run "make commanddocs"
 ---
 ## rclone dbhashsum
 

diff --git a/docs/content/commands/rclone_dedupe.md b/docs/content/commands/rclone_dedupe.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone dedupe"
 slug: rclone_dedupe
 url: /commands/rclone_dedupe/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/dedupe/ and as part of making a release run "make commanddocs"
 ---
 ## rclone dedupe
 

diff --git a/docs/content/commands/rclone_delete.md b/docs/content/commands/rclone_delete.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone delete"
 slug: rclone_delete
 url: /commands/rclone_delete/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/delete/ and as part of making a release run "make commanddocs"
 ---
 ## rclone delete
 

diff --git a/docs/content/commands/rclone_deletefile.md b/docs/content/commands/rclone_deletefile.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone deletefile"
 slug: rclone_deletefile
 url: /commands/rclone_deletefile/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/deletefile/ and as part of making a release run "make commanddocs"
 ---
 ## rclone deletefile
 

diff --git a/docs/content/commands/rclone_genautocomplete.md b/docs/content/commands/rclone_genautocomplete.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone genautocomplete"
 slug: rclone_genautocomplete
 url: /commands/rclone_genautocomplete/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/genautocomplete/ and as part of making a release run "make commanddocs"
 ---
 ## rclone genautocomplete
 

diff --git a/docs/content/commands/rclone_genautocomplete_bash.md b/docs/content/commands/rclone_genautocomplete_bash.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone genautocomplete bash"
 slug: rclone_genautocomplete_bash
 url: /commands/rclone_genautocomplete_bash/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/genautocomplete/bash/ and as part of making a release run "make commanddocs"
 ---
 ## rclone genautocomplete bash
 

diff --git a/docs/content/commands/rclone_genautocomplete_zsh.md b/docs/content/commands/rclone_genautocomplete_zsh.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone genautocomplete zsh"
 slug: rclone_genautocomplete_zsh
 url: /commands/rclone_genautocomplete_zsh/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/genautocomplete/zsh/ and as part of making a release run "make commanddocs"
 ---
 ## rclone genautocomplete zsh
 

diff --git a/docs/content/commands/rclone_gendocs.md b/docs/content/commands/rclone_gendocs.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone gendocs"
 slug: rclone_gendocs
 url: /commands/rclone_gendocs/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/gendocs/ and as part of making a release run "make commanddocs"
 ---
 ## rclone gendocs
 

diff --git a/docs/content/commands/rclone_hashsum.md b/docs/content/commands/rclone_hashsum.md
@@ -1,8 +1,9 @@
 ---
-date: 2020-02-01T10:26:53Z
+date: 2020-02-10T12:28:36Z
 title: "rclone hashsum"
 slug: rclone_hashsum
 url: /commands/rclone_hashsum/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/hashsum/ and as part of making a release run "make commanddocs"
 ---
 ## rclone hashsum