Doc: Fix broken links and anchors #364
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The XCP-ng technical documentation contained broken internal links and anchors, which caused warnings during Docusaurus builds and could prevent readers from finding the information they were looking for. This commit updates the incorrect links with the correct target URLs Signed-off-by: Thomas Moraine <[email protected]>
stormi
requested changes
Jun 25, 2025
docs/vms/vms.md
Outdated
| @@ -126,7 +126,7 @@ Make sure to check **Install I/O Drivers Now** during tools installation if you | |||
| ::: | |||
|
|
|||
| ##### Switching from XCP-ng tools to Citrix tools | |||
| If your VM already has XCP-ng tools and you wish to switch to Citrix tools, then you need to perform a clean-up as decribed in [Fully removing Xen PV drivers with XenClean](#fully-removing-xen-pv-drivers-with-xenclean). | |||
| If your VM already has XCP-ng tools and you wish to switch to Citrix tools, then you need to perform a clean-up as decribed in [Fully removing Xen PV drivers with XenClean](/vms/#fully-removing-xen-pv-drivers-with-xenclean). | |||
There was a problem hiding this comment.
This link worked perfectly and references a local anchor on purpose. You made it an absolute link towards the same page. If later we move the page, the link will break.
docs/vms/vms.md
Outdated
| @@ -150,7 +150,7 @@ Before creating the VM: | |||
| Before starting the VM: | |||
| * Check the value of "Manage Citrix PV drivers via Windows Update" in the Advanced tab of your VM in Xen Orchestra. Must be off. | |||
|
|
|||
| If you already started the VM with the option on, then the Citrix drivers have been installed automatically. Restart from scratch or go to Fully removing Xen PV drivers with XenClean](#fully-removing-xen-pv-drivers-with-xenclean). | |||
| If you already started the VM with the option on, then the Citrix drivers have been installed automatically. Restart from scratch or go to Fully removing Xen PV drivers with XenClean](/vms/#fully-removing-xen-pv-drivers-with-xenclean). | |||
docs/vms/vms.md
Outdated
| @@ -161,7 +161,7 @@ xe vm-param-get param-name=has-vendor-device uuid={VM-UUID} | |||
| ###### Install the XCP-ng drivers | |||
| 0. Snapshot your VM before installing (just in case) | |||
| 1. Check the above prerequisite about the "Manage Citrix PV drivers via Windows Update" option | |||
| 2. [Verify that no other guest tools are currently installed](#how-to-know-if-tools-are-already-installed-and-working). Our installer will block installation when other Xen tools are already present anyway. Use [XenClean](#Fully-removing-Xen-PV-drivers-with-XenClean) to remove any tools present. Do not uninstall the drivers in any other way: it may lead to BSOD at reboot (at least when uninstalling XCP-ng 8.2.2 tools) | |||
| 2. [Verify that no other guest tools are currently installed](#how-to-know-if-tools-are-already-installed-and-working). Our installer will block installation when other Xen tools are already present anyway. Use [XenClean](/vms/#fully-removing-xen-pv-drivers-with-xenclean) to remove any tools present. Do not uninstall the drivers in any other way: it may lead to BSOD at reboot (at least when uninstalling XCP-ng 8.2.2 tools) | |||
There was a problem hiding this comment.
That's not the proper fix. The problems are just the capitalized letters.
Suggested change
| 2. [Verify that no other guest tools are currently installed](#how-to-know-if-tools-are-already-installed-and-working). Our installer will block installation when other Xen tools are already present anyway. Use [XenClean](/vms/#fully-removing-xen-pv-drivers-with-xenclean) to remove any tools present. Do not uninstall the drivers in any other way: it may lead to BSOD at reboot (at least when uninstalling XCP-ng 8.2.2 tools) | |
| 2. [Verify that no other guest tools are currently installed](#how-to-know-if-tools-are-already-installed-and-working). Our installer will block installation when other Xen tools are already present anyway. Use [XenClean](#fully-removing-xen-pv-drivers-with-xenclean) to remove any tools present. Do not uninstall the drivers in any other way: it may lead to BSOD at reboot (at least when uninstalling XCP-ng 8.2.2 tools) |
docs/vms/vms.md
Outdated
| @@ -292,7 +292,7 @@ If you have enabled the option *Manage Citrix PV drivers via Windows Update*: In | |||
|
|
|||
| Follow Citrix's guidance in [CTX678047](https://support.citrix.com/s/article/CTX678047-static-ip-loss-when-updating-to-vm-tools-for-windows-933-or-earlier) to avoid losing your static IP settings during an upgrade. | |||
|
|
|||
| If you're using *XCP-ng Windows PV drivers* 8.2.x, you should use [XenClean](#fully-removing-xen-pv-drivers-with-xenclean) to remove the existing drivers, then choose one of the following: | |||
| If you're using *XCP-ng Windows PV drivers* 8.2.x, you should use [XenClean](/vms/#fully-removing-xen-pv-drivers-with-xenclean) to remove the existing drivers, then choose one of the following: | |||
docs/vms/vms.md
Outdated
| @@ -507,7 +507,7 @@ The likeliness for the installation to work correctly will depend on how much th | |||
|
|
|||
| For the remaining Linux distributions, mount the guest tools ISO as described above, then look for the `xe-guest-utilities_*_all.tgz` archive. Copy its contents on the system in `/etc` and `/usr`. It contains a System V init script by default but there's also a systemd unit file available on the ISO (`xe-linux-distribution.service`). | |||
|
|
|||
| See also [Contributing](#contributing) below. | |||
| See also [Contributing](/project/contributing/) below. | |||
There was a problem hiding this comment.
The proper fix is to remove this line, which references an anchor that doesn't exist anymore. And even if the fix would have been right, then "below" was not right anymore.
Suggested change
| See also [Contributing](/project/contributing/) below. |
docs/xostor/xostor.md
Outdated
| @@ -364,7 +364,7 @@ linstor controller set-property DrbdOptions/AutoEvictAllowEviction False | |||
| For each host of the pool (starting with the master), follow the instructions given in [this guide](../installation/upgrade/#-upgrade-via-installation-iso-recommended). | |||
|
|
|||
| :::warning | |||
| If you have this error during upgrade, you must download the right ISO version as documented in [this section](#2-download-xcp-ng-iso-with-linstor-support): | |||
| If you have this error during upgrade, you must download the right ISO version as documented in [this section](/xostor/#2-xcp-ng-iso-with-linstor-support): | |||
There was a problem hiding this comment.
Always prefer a link that remains local to the page.
Suggested change
| If you have this error during upgrade, you must download the right ISO version as documented in [this section](/xostor/#2-xcp-ng-iso-with-linstor-support): | |
| If you have this error during upgrade, you must download the right ISO version as documented in [this section](#2-xcp-ng-iso-with-linstor-support): |
Signed-off-by: Thomas Moraine <[email protected]>
|
This looks good to me. You can squash your commits (we don't need the history of changes made then cancelled) and then I'll approve and merge. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The XCP-ng technical documentation contained broken internal links and anchors, which caused warnings during Docusaurus builds and could prevent readers from finding the information they were looking for.
This PR updates the incorrect links with the correct target URLs