From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <o.bektas@proxmox.com> 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) server-digest SHA256) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id ADBA1606E8 for <pbs-devel@lists.proxmox.com>; Wed, 9 Sep 2020 17:52:43 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 97E6913453 for <pbs-devel@lists.proxmox.com>; Wed, 9 Sep 2020 17:52:43 +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) server-digest SHA256) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 69EF613446 for <pbs-devel@lists.proxmox.com>; Wed, 9 Sep 2020 17:52:42 +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 31E7044AD3 for <pbs-devel@lists.proxmox.com>; Wed, 9 Sep 2020 17:52:42 +0200 (CEST) Date: Wed, 9 Sep 2020 17:52:40 +0200 From: Oguz Bektas <o.bektas@proxmox.com> To: Thomas Lamprecht <t.lamprecht@proxmox.com> Cc: Proxmox Backup Server development discussion <pbs-devel@lists.proxmox.com> Message-ID: <20200909155240.GA51806@gaia.proxmox.com> References: <20200903124146.631667-1-o.bektas@proxmox.com> <d0f598c2-030b-c9d8-1a77-1dcfd13c4439@proxmox.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <d0f598c2-030b-c9d8-1a77-1dcfd13c4439@proxmox.com> User-Agent: Mutt/1.10.1 (2018-07-13) X-SPAM-LEVEL: Spam detection results: 0 AWL 1.186 Adjusted score from AWL reputation of From: address KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment 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 <pbs-devel.lists.proxmox.com> List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pbs-devel>, <mailto:pbs-devel-request@lists.proxmox.com?subject=unsubscribe> List-Archive: <http://lists.proxmox.com/pipermail/pbs-devel/> List-Post: <mailto:pbs-devel@lists.proxmox.com> List-Help: <mailto:pbs-devel-request@lists.proxmox.com?subject=help> List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel>, <mailto:pbs-devel-request@lists.proxmox.com?subject=subscribe> X-List-Received-Date: Wed, 09 Sep 2020 15:52:43 -0000 hi, On Fri, Sep 04, 2020 at 02:27:48PM +0200, Thomas Lamprecht wrote: > 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 "onlineHelp:" > references, so that more help buttons are shown or work there. thanks will do that as well - i wasn't sure which parts really needed to have the button so i didn't add any. it'll be in the v2 > > > --- > > 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(-) > > > > 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 > > ----------- > > > > +.. _chapter-backup-explanation: > > I'd drop the "chapter-" prefix, rather use the top-level (abbreviated, if long) > as prefix for lower level heading references. alright, i'll switch up the toplevel ones to that and remove it from the others. > > E.g., in PVE we use "qm" for all things in qemu-server, "qm_hard_disk", or an additional > level: "qm_hard_disk_bus", and so on. > > This could be > > .. _term-backup-content > > for example. But using the same prefix for all references is worse than using none > at all, IMO. > yeah, i'll try to come up with better names :)