Mercurial > libervia-backend
changeset 4174:6929dabf3a7e
doc (cli/blog): documentation of the new `--no-id-suffix` option.
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Tue, 05 Dec 2023 13:13:03 +0100 |
| parents | 7df6ba11bdae |
| children | 30f7513e5590 |
| files | doc/libervia-cli/blog.rst |
| diffstat | 1 files changed, 20 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/libervia-cli/blog.rst Tue Dec 05 13:12:01 2023 +0100 +++ b/doc/libervia-cli/blog.rst Tue Dec 05 13:13:03 2023 +0100 @@ -7,6 +7,22 @@ Blog commands are high level tools to handle an XMPP blog. They are using the generic pubsub arguments + +.. _libervia_cli_blog_common_pub: + +Common Publishing Options +========================= + +The `set` and `edit` commands support a range of options for customizing blog post creation and editing. Some notable options include: + +``--no-id-suffix`` + + This option removes the randomly generated suffix from the auto-generated, user-friendly ID. The suffix is initially added to ensure unique IDs, especially useful when two posts have similar titles. Use this option with caution, as it may lead to ID conflicts and potential overwriting of existing posts. + + .. warning:: + + Use this option judiciously to avoid unintended overwriting of blog posts. + set === @@ -16,6 +32,8 @@ ``stdin`` is used to get the body of the blog post. +Also see :ref:`libervia_cli_blog_common_pub`. + |e2e_arg| |pte_arg| @@ -109,6 +127,8 @@ If --preview doesn't work, use ``li blog preview`` (see below) to get error messages. On GNU/Linux, Be sure that inotify Python module is installed correctly. +Also see :ref:`libervia_cli_blog_common_pub`. + |e2e_arg| |pte_arg|