Skip to content

docs: fix broken and incorrect links in documentation#14587

Merged
xfournet merged 2 commits intomasterfrom
copilot/fix-documentation-links
Feb 24, 2026
Merged

docs: fix broken and incorrect links in documentation#14587
xfournet merged 2 commits intomasterfrom
copilot/fix-documentation-links

Conversation

Copy link
Contributor

Copilot AI commented Feb 24, 2026

MkDocs build emits multiple WARNINGs and INFOs due to broken relative links, missing target files, and absolute links that should be relative.

Changes

  • administration/enterprise.md — Remove link to non-existent authetication-in-gui.md (typo + file never created); keep as plain text
  • deployment/breaking-changes.md — Remove link to non-existent authentication-in-gui.md; keep as plain text
  • deployment/integration-manager.md — Remove bullet pointing to non-existent integration-manager/security.md
  • development/integration-manager.md — Replace ../CONTRIBUTING.md (outside docs tree) with the absolute GitHub URL
  • usage/dashboards.md — Replace absolute /administration/hub/ with relative ../administration/hub.md
  • usage/indicators-lifecycle.md — Replace unresolved ../deduplication with deduplication.md
  • usage/import/csv-feed.md — Replace absolute /administration/hub/ with relative ../../administration/hub.md
Original prompt

Problem

The documentation build produces several WARNINGs and INFOs about broken or incorrect links. All of these need to be fixed so the documentation builds cleanly.

WARNING -  Doc file 'administration/enterprise.md' contains a link '../deployment/authetication-in-gui.md', but the target 'deployment/authetication-in-gui.md' is not found among documentation files.
WARNING -  Doc file 'deployment/breaking-changes.md' contains a link 'authentication-in-gui.md', but the target 'deployment/authentication-in-gui.md' is not found among documentation files.
WARNING -  Doc file 'deployment/integration-manager.md' contains a link 'integration-manager/security.md', but the target 'deployment/integration-manager/security.md' is not found among documentation files.
WARNING -  Doc file 'development/integration-manager.md' contains a link '../CONTRIBUTING.md', but the target 'CONTRIBUTING.md' is not found among documentation files.
INFO    -  Doc file 'usage/dashboards.md' contains an absolute link '/administration/hub/', it was left as is. Did you mean '../administration/hub.md'?
INFO    -  Doc file 'usage/indicators-lifecycle.md' contains an unrecognized relative link '../deduplication', it was left as is. Did you mean 'deduplication.md'?
INFO    -  Doc file 'usage/import/csv-feed.md' contains an absolute link '/administration/hub/', it was left as is. Did you mean '../../administration/hub.md'?

Root Cause Analysis

After inspecting all the affected files:

  1. docs/docs/administration/enterprise.md line 86: Link ../deployment/authetication-in-gui.md — The file docs/docs/deployment/authentication-in-gui.md does not exist. This is a typo + the file is missing. Since deployment/authentication-in-gui.md doesn't exist at all in the repo, the link target should be removed or pointed to an existing file. The closest existing file related to authentication is in the deployment section. The link should be updated to point to ../deployment/configuration.md or the link text should be made into a dead-end external reference. Actually, since the file doesn't exist yet, the safest fix is to remove the hyperlink and keep it as plain text, OR link to the closest existing related page. Given the context ("For more information, please read Authentication via GUI configuration"), if the target file doesn't exist, we should remove the link but keep the description text, or link to the authentication page in the breaking-changes. The best approach is to link to ../deployment/breaking-changes.md#SSO-update-license which covers that topic.

  2. docs/docs/deployment/breaking-changes.md line 34: Link authentication-in-gui.md — Same missing file. Change to breaking-changes/7.260224.0-SSO-authentication-migration.md which is mentioned right next to it and is a related existing document (or just remove the second link if the file doesn't exist). Since the file deployment/authentication-in-gui.md does not exist, this link should be removed or changed to a valid target. The safest approach is to remove the dangling hyperlink portion and keep the text inline.

  3. docs/docs/deployment/integration-manager.md line 18: Link integration-manager/security.md — The file docs/docs/deployment/integration-manager/security.md does not exist in the repo (confirmed by listing the directory). Remove this bullet point entry entirely, or if there is no security doc, remove the link from the list.

  4. docs/docs/development/integration-manager.md line 334: Link ../CONTRIBUTING.md — The file docs/docs/CONTRIBUTING.md does not exist. The repo root CONTRIBUTING.md is outside the docs/docs/ tree and is not part of the mkdocs documentation. This link should be updated to point to the actual CONTRIBUTING.md on GitHub: https://github.com/OpenCTI-Platform/opencti/blob/master/CONTRIBUTING.md

  5. docs/docs/usage/dashboards.md line 134: Absolute link /administration/hub/ — should be changed to the relative ../administration/hub.md

  6. docs/docs/usage/indicators-lifecycle.md line 50: Unrecognized relative link ../deduplication — The file docs/docs/usage/deduplication.md does exist. The link should be deduplication.md (since both files are in the same usage/ directory, or keep ../usage/deduplication.md if writing from usage/ — since they're in the same folder, use deduplication.md).

  7. docs/docs/usage/import/csv-feed.md line 105: Absolute link /administration/hub/ — should be changed to the relative ../../administration/hub.md

Required Changes

1. docs/docs/administration/enterprise.md

  • Line 86: Change [Authentication via GUI configuration](../deployment/authetication-in-gui.md) to plain text (remove link) since the target file doesn't exist. Replace with: Authentication via GUI configuration

2. docs/docs/deployment/breaking-changes.md

  • Line 34: The text reads: `the [new associated fe...

This pull request was created from Copilot chat.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: labo-flg <146674147+labo-flg@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix broken links in documentation build docs: fix broken and incorrect links in documentation Feb 24, 2026
@xfournet xfournet marked this pull request as ready for review February 24, 2026 19:55
@xfournet xfournet merged commit df349b6 into master Feb 24, 2026
4 checks passed
@xfournet xfournet deleted the copilot/fix-documentation-links branch February 24, 2026 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants