Re: [pbs-devel] [PATCH proxmox-backup] docs: add labels for onlinehelp anchors

[Thomas Lamprecht <t.lamprecht@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.