From: Thomas Lamprecht <t.lamprecht@proxmox.com>
To: Proxmox Backup Server development discussion
<pbs-devel@lists.proxmox.com>, Oguz Bektas <o.bektas@proxmox.com>
Subject: Re: [pbs-devel] [PATCH proxmox-backup] docs: add labels for onlinehelp anchors
Date: Fri, 4 Sep 2020 14:27:48 +0200 [thread overview]
Message-ID: <d0f598c2-030b-c9d8-1a77-1dcfd13c4439@proxmox.com> (raw)
In-Reply-To: <20200903124146.631667-1-o.bektas@proxmox.com>
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.
> ---
> 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.
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.
next prev parent reply other threads:[~2020-09-04 12:28 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-03 12:41 Oguz Bektas
2020-09-04 12:27 ` Thomas Lamprecht [this message]
2020-09-09 15:52 ` Oguz Bektas
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=d0f598c2-030b-c9d8-1a77-1dcfd13c4439@proxmox.com \
--to=t.lamprecht@proxmox.com \
--cc=o.bektas@proxmox.com \
--cc=pbs-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox