From ee39c96c788b10579cfd4cbe09143bcfde36b981 Mon Sep 17 00:00:00 2001 From: Francis Lavoie Date: Mon, 17 Jul 2023 20:51:37 -0400 Subject: [PATCH] Docs for v2.7.0 followup - Mark some things as experimental - Complete my sentence for `caddy storage` command --- src/docs/markdown/caddyfile/concepts.md | 2 ++ src/docs/markdown/caddyfile/directives/invoke.md | 2 ++ src/docs/markdown/command-line.md | 10 +++++++++- 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/src/docs/markdown/caddyfile/concepts.md b/src/docs/markdown/caddyfile/concepts.md index e9f6b384..769909bb 100644 --- a/src/docs/markdown/caddyfile/concepts.md +++ b/src/docs/markdown/caddyfile/concepts.md @@ -337,6 +337,8 @@ b.example.com { ## Named Routes +⚠️ Experimental + Named routes use syntax similar to [snippets](#snippets); they're a special block defined outside of site blocks, prefixed with `&(` and ending in `)` with the name in between. ```caddy diff --git a/src/docs/markdown/caddyfile/directives/invoke.md b/src/docs/markdown/caddyfile/directives/invoke.md index b76a8102..962368e6 100644 --- a/src/docs/markdown/caddyfile/directives/invoke.md +++ b/src/docs/markdown/caddyfile/directives/invoke.md @@ -4,6 +4,8 @@ title: invoke (Caddyfile directive) # invoke +⚠️ Experimental + Invokes a [named route](/docs/caddyfile/concepts#named-routes). This is useful when paired with HTTP handler directives that have their own in-memory state, or if they are expensive to provision on load. If you have hundreds of sites or more, invoking a named route can help reduce memory usage. diff --git a/src/docs/markdown/command-line.md b/src/docs/markdown/command-line.md index d14797d1..ae40da86 100644 --- a/src/docs/markdown/command-line.md +++ b/src/docs/markdown/command-line.md @@ -512,11 +512,13 @@ If you want to stop the current configuration but do not want to exit the proces ### `caddy storage` +⚠️ Experimental + Allows export and import of the contents of Caddy's configured data storage. This is useful when needing to transition from one [storage module](/docs/json/storage/) to another, by exporting from your old one, updating your config, then importing into the new one. -The following command can be used to do this all in one shot, using and old and new config with different configured storage modules, piping the export output into the +The following command can be used to copy the storage between different modules in one shot, using old and new configs, piping the export command's output into the import command. ``` $ caddy storage export -c Caddyfile.old -o- | @@ -596,6 +598,8 @@ If the admin API is used, then the CA ID defaults to "local". You may specify th ### `caddy upgrade` +⚠️ Experimental +
caddy upgrade
 	[-k, --keep-backup]
@@ -611,6 +615,8 @@ This command may require elevated privileges if your user does not have permissi ### `caddy add-package` +⚠️ Experimental +
caddy add-package <packages...>
 	[-k, --keep-backup]
@@ -624,6 +630,8 @@ For example: ### `caddy remove-package` +⚠️ Experimental +
caddy remove-package <packages...>
 	[-k, --keep-backup]