From e3370c0a007e8cea0d304587439240f5e7fb8618 Mon Sep 17 00:00:00 2001 From: Goffi Date: Tue, 5 Dec 2023 13:13:03 +0100 Subject: [PATCH] doc (cli/blog): documentation of the new `--no-id-suffix` option. --- doc/libervia-cli/blog.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/doc/libervia-cli/blog.rst b/doc/libervia-cli/blog.rst index b2b93d53..69001270 100644 --- a/doc/libervia-cli/blog.rst +++ b/doc/libervia-cli/blog.rst @@ -7,6 +7,22 @@ blog: (micro)blogging management 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 @@ publish a blog item. ``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 @@ configuration `_ below to see how to do. 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|