docs/online-help: prefix some refs with their chapter name

and fix some issues from referenced named the same as their heading
they anchor too.

This should be fixed for real in our python plugin to scan for such
references, its probably a bug there, but as most of the problematic
ones where wrong (missing chapter prefix) anyway changing them is OK
too.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2021-02-05 11:42:04 +01:00
parent 25aa55b5f5
commit ec1ae7e631
5 changed files with 31 additions and 16 deletions

View File

@ -86,7 +86,7 @@ Please use the following environment variables to modify output behavior:
format if you need to process the output. format if you need to process the output.
.. _creating-backups: .. _client_creating_backups:
Creating Backups Creating Backups
---------------- ----------------
@ -246,7 +246,7 @@ Restoring this backup will result in:
. .. file2 . .. file2
.. _encryption: .. _client_encryption:
Encryption Encryption
---------- ----------
@ -660,7 +660,7 @@ shows the list of existing snapshots and what actions prune would take.
space you need to perform :ref:`garbage-collection`. space you need to perform :ref:`garbage-collection`.
.. _garbage-collection: .. _client_garbage-collection:
Garbage Collection Garbage Collection
------------------ ------------------

View File

@ -1,5 +1,4 @@
.. _calendar-event-scheduling:
.. _calendar-events:
Calendar Events Calendar Events
=============== ===============

View File

@ -1,8 +1,8 @@
.. _tech_design_overview:
Technical Overview Technical Overview
================== ==================
.. _technical_overview:
Datastores Datastores
---------- ----------

View File

@ -1,4 +1,4 @@
.. _terminology: .. _terms:
Terminology Terminology
=========== ===========
@ -101,7 +101,7 @@ Backup Group
The tuple ``<type>/<ID>`` is called a backup group. Such a group The tuple ``<type>/<ID>`` is called a backup group. Such a group
may contain one or more backup snapshots. may contain one or more backup snapshots.
.. _backup_snapshot: .. _term_backup_snapshot:
Backup Snapshot Backup Snapshot
--------------- ---------------

View File

@ -3,12 +3,12 @@ const proxmoxOnlineHelpInfo = {
"link": "/docs/index.html", "link": "/docs/index.html",
"title": "Proxmox Backup Server Documentation Index" "title": "Proxmox Backup Server Documentation Index"
}, },
"id1": { "client-creating-backups": {
"link": "/docs/calendarevents.html#id1", "link": "/docs/backup-client.html#client-creating-backups",
"title": "Calendar Events" "title": "Creating Backups"
}, },
"id2": { "client-encryption": {
"link": "/docs/backup-client.html#id2", "link": "/docs/backup-client.html#client-encryption",
"title": "Encryption" "title": "Encryption"
}, },
"changing-backup-owner": { "changing-backup-owner": {
@ -19,10 +19,14 @@ const proxmoxOnlineHelpInfo = {
"link": "/docs/backup-client.html#backup-pruning", "link": "/docs/backup-client.html#backup-pruning",
"title": "Pruning and Removing Backups" "title": "Pruning and Removing Backups"
}, },
"id3": { "client-garbage-collection": {
"link": "/docs/backup-client.html#id3", "link": "/docs/backup-client.html#client-garbage-collection",
"title": "Garbage Collection" "title": "Garbage Collection"
}, },
"calendar-event-scheduling": {
"link": "/docs/calendarevents.html#calendar-event-scheduling",
"title": "Calendar Events"
},
"pxar-format": { "pxar-format": {
"link": "/docs/file-formats.html#pxar-format", "link": "/docs/file-formats.html#pxar-format",
"title": "Proxmox File Archive Format (``.pxar``)" "title": "Proxmox File Archive Format (``.pxar``)"
@ -95,6 +99,18 @@ const proxmoxOnlineHelpInfo = {
"link": "/docs/tape-backup.html#restore-encryption-key", "link": "/docs/tape-backup.html#restore-encryption-key",
"title": "Restoring Encryption Keys" "title": "Restoring Encryption Keys"
}, },
"tech-design-overview": {
"link": "/docs/technical-overview.html#tech-design-overview",
"title": "Technical Overview"
},
"terms": {
"link": "/docs/terminology.html#terms",
"title": "Terminology"
},
"term-backup-snapshot": {
"link": "/docs/terminology.html#term-backup-snapshot",
"title": "Backup Snapshot"
},
"user-mgmt": { "user-mgmt": {
"link": "/docs/user-management.html#user-mgmt", "link": "/docs/user-management.html#user-mgmt",
"title": "User Management" "title": "User Management"