Skip to content

Fixed broken page links#309

Open
mikej888 wants to merge 2 commits intomainfrom
mikej888/fix-broken-links
Open

Fixed broken page links#309
mikej888 wants to merge 2 commits intomainfrom
mikej888/fix-broken-links

Conversation

@mikej888
Copy link
Contributor

EIDF Documentation Pull Request

Description

Fixed broken page links warned about when running local server:

$ mkdocs serve -a localhost:9999
WARNING -  Doc file 'safe-haven-services/open-ondemand/containers.md' contains a link
           '../tre-container-user-guide/introduction.md', but the target
           'safe-haven-services/tre-container-user-guide/introduction.md' is not found
           among documentation files.

Updated docs/safe-haven-services/open-ondemand/containers.md, fixed link to be to ../shs-container-user-guide/introduction.md.

WARNING -  Doc file 'safe-haven-services/tre-gpu-service/index.md' contains a link
           '../virtual-desktop-connections.md', but the target
           'safe-haven-services/virtual-desktop-connections.md' is not found among
           documentation files.

Updated docs/safe-haven-services/tre-gpu-service/index.md, fixed link to be to ../safe-haven-access.md and tweaked link text.

INFO    -  Doc file
           'safe-haven-services/tre-gpu-service/training/L4_requesting_persistent_volumes.md'
           contains an unrecognized relative link '../L1_getting_started/#requirements',
           it was left as is. Did you mean 'L1_getting_started.md#requirements'?

Updated docs/safe-haven-services/tre-gpu-service/training/L4_requesting_persistent_volumes.md, fixed link to be to ./L1_getting_started.md.

INFO    -  Doc file
           'safe-haven-services/tre-gpu-service/training/L5_running_a_pytorch_task.md'
           contains an unrecognized relative link '../L1_getting_started/#requirements',
           it was left as is. Did you mean 'L1_getting_started.md#requirements'?
INFO    -  Doc file
           'safe-haven-services/tre-gpu-service/training/L5_running_a_pytorch_task.md'
           contains an unrecognized relative link
           '../L2_requesting_persistent_volumes/#requirements', it was left as is.

Updated docs/safe-haven-services/tre-gpu-service/training/L5_running_a_pytorch_task.md, fixed links to be to (./L1_getting_started.md) and (./L4_requesting_persistent_volumes.md).

INFO    -  Doc file 'safe-haven-services/tre-gpu-service/training/L6_template_workflow.md'
           contains an unrecognized relative link '../L1_getting_started/#requirements',
           it was left as is. Did you mean 'L1_getting_started.md#requirements'?
INFO    -  Doc file 'safe-haven-services/tre-gpu-service/training/L6_template_workflow.md'
           contains an unrecognized relative link
           '../L4_requesting_persistent_volumes/#requirements', it was left as is. Did you
           mean 'L4_requesting_persistent_volumes.md#requirements'?

Updated docs/safe-haven-services/tre-gpu-service/training/L6_template_workflow.md, fixed links to be to (./L1_getting_started.md) and (./L4_requesting_persistent_volumes.md).

INFO    -  Doc file 'safe-haven-services/shs-container-user-guide/development-workflow.md'
           contains a link './introduction.md#overview', but the doc
           'safe-haven-services/shs-container-user-guide/introduction.md' does not contain
           an anchor '#overview'.

Updated docs/safe-haven-services/shs-container-user-guide/development-workflow.md, fixed link to be to ./introduction.md and tweaked link text.

Type of change

  • Incorrect Documentation

What has to be reviewed

docs/safe-haven-services/open-ondemand/containers.md
docs/safe-haven-services/tre-gpu-service/index.md
docs/safe-haven-services/tre-gpu-service/training/L4_requesting_persistent_volumes.md`
docs/safe-haven-services/tre-gpu-service/training/L5_running_a_pytorch_task.md
docs/safe-haven-services/tre-gpu-service/training/L6_template_workflow.md
docs/safe-haven-services/shs-container-user-guide/development-workflow.md

Checklist

  • Documentation follows the project style guidelines
  • Self-review of documentation using mkdocs on local system
  • Spellcheck has been performed
  • Pre-commit has been run and passed

Fixed broken page links warned about when running local server:
```console
$ mkdocs serve -a localhost:9999
```
```text
WARNING -  Doc file 'safe-haven-services/open-ondemand/containers.md' contains a link
           '../tre-container-user-guide/introduction.md', but the target
           'safe-haven-services/tre-container-user-guide/introduction.md' is not found
           among documentation files.
```
Updated `docs/safe-haven-services/open-ondemand/containers.md`, fixed link to be to `../shs-container-user-guide/introduction.md`.
```text
WARNING -  Doc file 'safe-haven-services/tre-gpu-service/index.md' contains a link
           '../virtual-desktop-connections.md', but the target
           'safe-haven-services/virtual-desktop-connections.md' is not found among
           documentation files.
```
Updated `docs/safe-haven-services/tre-gpu-service/index.md`, fixed link to be to `../safe-haven-access.md` and tweaked link text.
```text
INFO    -  Doc file
           'safe-haven-services/tre-gpu-service/training/L4_requesting_persistent_volumes.md'
           contains an unrecognized relative link '../L1_getting_started/#requirements',
           it was left as is. Did you mean 'L1_getting_started.md#requirements'?
```
Updated `docs/safe-haven-services/tre-gpu-service/training/L4_requesting_persistent_volumes.md`, fixed link to be to `./L1_getting_started.md`.
```text
INFO    -  Doc file
           'safe-haven-services/tre-gpu-service/training/L5_running_a_pytorch_task.md'
           contains an unrecognized relative link '../L1_getting_started/#requirements',
           it was left as is. Did you mean 'L1_getting_started.md#requirements'?
```
```text
INFO    -  Doc file
           'safe-haven-services/tre-gpu-service/training/L5_running_a_pytorch_task.md'
           contains an unrecognized relative link
           '../L2_requesting_persistent_volumes/#requirements', it was left as is.
```
Updated `docs/safe-haven-services/tre-gpu-service/training/L5_running_a_pytorch_task.md`, fixed links to be to `(./L1_getting_started.md)` and `(./L4_requesting_persistent_volumes.md)`.
```text
INFO    -  Doc file 'safe-haven-services/tre-gpu-service/training/L6_template_workflow.md'
           contains an unrecognized relative link '../L1_getting_started/#requirements',
           it was left as is. Did you mean 'L1_getting_started.md#requirements'?
```
```text
INFO    -  Doc file 'safe-haven-services/tre-gpu-service/training/L6_template_workflow.md'
           contains an unrecognized relative link
           '../L4_requesting_persistent_volumes/#requirements', it was left as is. Did you
           mean 'L4_requesting_persistent_volumes.md#requirements'?
```
Updated `docs/safe-haven-services/tre-gpu-service/training/L6_template_workflow.md`, fixed links to be to `(./L1_getting_started.md)` and `(./L4_requesting_persistent_volumes.md)`.
```text
INFO    -  Doc file 'safe-haven-services/shs-container-user-guide/development-workflow.md'
           contains a link './introduction.md#overview', but the doc
           'safe-haven-services/shs-container-user-guide/introduction.md' does not contain
           an anchor '#overview'.
```
Updated `docs/safe-haven-services/shs-container-user-guide/development-workflow.md`, fixed link to be to `./introduction.md` and tweaked link text.
@mikej888 mikej888 assigned mikej888 and unassigned mikej888 Feb 16, 2026
@mikej888 mikej888 added the documentation Improvements or additions to documentation label Feb 16, 2026
@mikej888 mikej888 requested a review from kavousan February 16, 2026 11:35
Copy link
Contributor

@kavousan kavousan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just the one wee thing. Thanks for fixing these.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ContainerS...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, commited the fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants