From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id D5B336104A for ; Fri, 4 Sep 2020 14:28:20 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id C4D6A20A19 for ; Fri, 4 Sep 2020 14:27:50 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [212.186.127.180]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id A3CD620A0D for ; Fri, 4 Sep 2020 14:27:49 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 6971144A17 for ; Fri, 4 Sep 2020 14:27:49 +0200 (CEST) To: Proxmox Backup Server development discussion , Oguz Bektas References: <20200903124146.631667-1-o.bektas@proxmox.com> From: Thomas Lamprecht Message-ID: Date: Fri, 4 Sep 2020 14:27:48 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:81.0) Gecko/20100101 Thunderbird/81.0 MIME-Version: 1.0 In-Reply-To: <20200903124146.631667-1-o.bektas@proxmox.com> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: quoted-printable X-SPAM-LEVEL: Spam detection results: 0 AWL 1.066 Adjusted score from AWL reputation of From: address KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment NICE_REPLY_A -2.403 Looks like a legit reply (A) RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: Re: [pbs-devel] [PATCH proxmox-backup] docs: add labels for onlinehelp anchors X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 04 Sep 2020 12:28:20 -0000 On 03.09.20 14:41, Oguz Bektas wrote: > define references for some sections for easy adding into onlinehelpinfo= Thanks! ideally you'd already add, at least some, uses in the UI as "onli= neHelp:"=20 references, so that more help buttons are shown or work there. > --- > docs/administration-guide.rst | 34 +++++++++++++++++++++++++++++++++- > docs/installation.rst | 3 +++ > docs/introduction.rst | 4 ++++ > docs/package-repositories.rst | 2 ++ > 4 files changed, 42 insertions(+), 1 deletion(-) >=20 > diff --git a/docs/administration-guide.rst b/docs/administration-guide.= rst > index e6357a3e..e514beb1 100644 > --- a/docs/administration-guide.rst > +++ b/docs/administration-guide.rst > @@ -7,6 +7,8 @@ Backup Management > Terminology > ----------- > =20 > +.. _chapter-backup-explanation: I'd drop the "chapter-" prefix, rather use the top-level (abbreviated, if= long) as prefix for lower level heading references. E.g., in PVE we use "qm" for all things in qemu-server, "qm_hard_disk", o= r an additional level: "qm_hard_disk_bus", and so on. This could be =2E. _term-backup-content for example. But using the same prefix for all references is worse than u= sing none at all, IMO.