From ec1ae7e63180768c9ad8fa52d437a1cee6ef1c50 Mon Sep 17 00:00:00 2001 From: Thomas Lamprecht Date: Fri, 5 Feb 2021 11:42:04 +0100 Subject: [PATCH] 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 --- docs/backup-client.rst | 6 +++--- docs/calendarevents.rst | 3 +-- docs/technical-overview.rst | 4 ++-- docs/terminology.rst | 4 ++-- www/OnlineHelpInfo.js | 30 +++++++++++++++++++++++------- 5 files changed, 31 insertions(+), 16 deletions(-) diff --git a/docs/backup-client.rst b/docs/backup-client.rst index 1c35818f3..800ee43f5 100644 --- a/docs/backup-client.rst +++ b/docs/backup-client.rst @@ -86,7 +86,7 @@ Please use the following environment variables to modify output behavior: format if you need to process the output. -.. _creating-backups: +.. _client_creating_backups: Creating Backups ---------------- @@ -246,7 +246,7 @@ Restoring this backup will result in: . .. file2 -.. _encryption: +.. _client_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`. -.. _garbage-collection: +.. _client_garbage-collection: Garbage Collection ------------------ diff --git a/docs/calendarevents.rst b/docs/calendarevents.rst index 6f60ed18f..cffd124f4 100644 --- a/docs/calendarevents.rst +++ b/docs/calendarevents.rst @@ -1,5 +1,4 @@ - -.. _calendar-events: +.. _calendar-event-scheduling: Calendar Events =============== diff --git a/docs/technical-overview.rst b/docs/technical-overview.rst index d354efee0..9dba2557f 100644 --- a/docs/technical-overview.rst +++ b/docs/technical-overview.rst @@ -1,8 +1,8 @@ +.. _tech_design_overview: + Technical Overview ================== -.. _technical_overview: - Datastores ---------- diff --git a/docs/terminology.rst b/docs/terminology.rst index 3eff97806..5a2e30a05 100644 --- a/docs/terminology.rst +++ b/docs/terminology.rst @@ -1,4 +1,4 @@ -.. _terminology: +.. _terms: Terminology =========== @@ -101,7 +101,7 @@ Backup Group The tuple ``/`` is called a backup group. Such a group may contain one or more backup snapshots. -.. _backup_snapshot: +.. _term_backup_snapshot: Backup Snapshot --------------- diff --git a/www/OnlineHelpInfo.js b/www/OnlineHelpInfo.js index ece5a0127..57d195d58 100644 --- a/www/OnlineHelpInfo.js +++ b/www/OnlineHelpInfo.js @@ -3,12 +3,12 @@ const proxmoxOnlineHelpInfo = { "link": "/docs/index.html", "title": "Proxmox Backup Server Documentation Index" }, - "id1": { - "link": "/docs/calendarevents.html#id1", - "title": "Calendar Events" + "client-creating-backups": { + "link": "/docs/backup-client.html#client-creating-backups", + "title": "Creating Backups" }, - "id2": { - "link": "/docs/backup-client.html#id2", + "client-encryption": { + "link": "/docs/backup-client.html#client-encryption", "title": "Encryption" }, "changing-backup-owner": { @@ -19,10 +19,14 @@ const proxmoxOnlineHelpInfo = { "link": "/docs/backup-client.html#backup-pruning", "title": "Pruning and Removing Backups" }, - "id3": { - "link": "/docs/backup-client.html#id3", + "client-garbage-collection": { + "link": "/docs/backup-client.html#client-garbage-collection", "title": "Garbage Collection" }, + "calendar-event-scheduling": { + "link": "/docs/calendarevents.html#calendar-event-scheduling", + "title": "Calendar Events" + }, "pxar-format": { "link": "/docs/file-formats.html#pxar-format", "title": "Proxmox File Archive Format (``.pxar``)" @@ -95,6 +99,18 @@ const proxmoxOnlineHelpInfo = { "link": "/docs/tape-backup.html#restore-encryption-key", "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": { "link": "/docs/user-management.html#user-mgmt", "title": "User Management"