Add missing .md to the MetalBox ZTP link - #1050
Merged
Merged
Conversation
The link to the SONiC ZTP section omitted the file extension: [... via ZTP](./metalbox#sonic-ztp) Docusaurus resolves extensionless links, so the site builds and the link works. lychee does not: it checks the literal path docs/concepts/metalbox, which does not exist on disk, and reports "File not found" on every run. That report is currently non-blocking, so it has been sitting in the MegaLinter output as a permanent error. It is a deviation rather than a broken link. Explicit .md is the convention here -- 100 internal links use it, including the very next link in this same file (./cluster-network.md) -- and this was the only extensionless file link left in docs/. Adding the extension satisfies lychee without changing any rendered output. Assisted-by: Claude:claude-opus-5 Signed-off-by: Roger Luethi <luethi@osism.tech>
✅
|
| Descriptor | Linter | Files | Fixed | Errors | Warnings | Elapsed time |
|---|---|---|---|---|---|---|
| ✅ ACTION | actionlint | 5 | 0 | 0 | 0.03s | |
| ✅ JSON | jsonlint | 4 | 0 | 0 | 0.08s | |
| ✅ JSON | prettier | 4 | 0 | 0 | 0.36s | |
| ✅ JSON | v8r | 4 | 0 | 0 | 10.56s | |
| ✅ MARKDOWN | markdownlint | 158 | 0 | 0 | 2.46s | |
| ✅ MARKDOWN | markdown-table-formatter | 158 | 0 | 0 | 0.44s | |
| ✅ REPOSITORY | betterleaks | yes | no | no | 0.88s | |
| ✅ REPOSITORY | checkov | yes | no | no | 21.21s | |
| ✅ REPOSITORY | git_diff | yes | no | no | 0.08s | |
| ✅ REPOSITORY | secretlint | yes | no | no | 1.94s | |
| ✅ REPOSITORY | trufflehog | yes | no | no | 4.5s | |
| ✅ SPELL | codespell | 168 | 0 | 0 | 0.61s | |
| lychee | 168 | 1 | 0 | 27.31s | ||
| ✅ YAML | prettier | 6 | 0 | 0 | 0.46s | |
| ✅ YAML | v8r | 6 | 0 | 0 | 7.68s | |
| ✅ YAML | yamllint | 6 | 0 | 0 | 0.63s |
Detailed Issues
⚠️ SPELL / lychee - 1 error
📝 Summary
---------------------
🔍 Total..........897
🔗 Unique.........726
✅ Successful.....841
⏳ Timeouts.........4
🔀 Redirected.......3
👻 Excluded........52
❓ Unknown..........0
🚫 Errors...........0
⛔ Unsupported......0
Errors in docs/guides/deploy-guide/services/openstack.md
[TIMEOUT] https://www.openstack.org/software/project-navigator/openstack-components#openstack-services (at 14:5) | Request timed out
Errors in docs/guides/user-guide/openstack/migration-vmware-esxi.md
[TIMEOUT] https://www.openstack.org/vmware-migration-to-openstack/ (at 20:1) | Request timed out
Errors in docs/release-notes/osism-7.md
[TIMEOUT] https://www.openstack.org/software/openstack-bobcat (at 978:38) | Request timed out
Errors in docs/release-notes/osism-8.md
[TIMEOUT] https://www.openstack.org/software/openstack-caracal (at 223:38) | Request timed out
Hint: Followed 3 redirects. You might want to consider replacing redirecting URLs with the resolved URLs. Use verbose mode (`-v`/`-vv`) to see redirection details.
Notices
📣 MegaLinter 9.5.0 is out! Discover the new features and security recommendations in the release announcement. (Skip this info by defining SECURITY_SUGGESTIONS: false)
See detailed reports in MegaLinter artifacts
Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining FLAVOR_SUGGESTIONS: false)
- Documentation: Custom Flavors
- Command:
npx mega-linter-runner@9.6.0 --custom-flavor-setup --custom-flavor-linters ACTION_ACTIONLINT,JSON_JSONLINT,JSON_V8R,JSON_PRETTIER,MARKDOWN_MARKDOWNLINT,MARKDOWN_MARKDOWN_TABLE_FORMATTER,REPOSITORY_CHECKOV,REPOSITORY_GIT_DIFF,REPOSITORY_BETTERLEAKS,REPOSITORY_SECRETLINT,REPOSITORY_TRUFFLEHOG,SPELL_LYCHEE,SPELL_CODESPELL,YAML_PRETTIER,YAML_YAMLLINT,YAML_V8R

Show us your support by starring ⭐ the repository
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
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 link to the SONiC ZTP section omits the file extension:
Docusaurus resolves extensionless links, so the site builds and the link works.
lychee does not: it checks the literal path
docs/concepts/metalbox, which doesnot exist on disk, and reports
File not foundon every run. That report isnon-blocking, so it has been sitting in the MegaLinter output as a permanent
error rather than failing anything.
This is a deviation rather than a broken link. Explicit
.mdis the conventionhere — 100 internal links use it, including the very next link in this same file
(
./cluster-network.md) — and this was the only extensionless file link left indocs/. Adding the extension changes no rendered output.Verification
docs/concepts/metalbox.mdexists, so the path lychee checks now resolves.## SONiC ZTPatmetalbox.md:161, which Docusaurusslugifies to
#sonic-ztp.I could not run lychee locally (no binary available; it is a Rust tool rather
than an npm package), so the expectation that this clears the warning is
inferred from lychee's own error message — the literal path it reported as
missing now exists. The MegaLinter run on this PR is the actual confirmation.
Noticed while looking at an unrelated MegaLinter failure on
#1048; this link is pre-existing and independent of that
change.
🤖 Generated with Claude Code