Skip to content

Comments

Fix: Index linkcheck warning#549

Merged
bmunkholm merged 2 commits intomainfrom
bm/fix-index
Feb 12, 2026
Merged

Fix: Index linkcheck warning#549
bmunkholm merged 2 commits intomainfrom
bm/fix-index

Conversation

@bmunkholm
Copy link
Contributor

@bmunkholm bmunkholm commented Feb 12, 2026

About

make check (linkchecking) gave warnings and causing failed build in CI.

Preview

@coderabbitai
Copy link

coderabbitai bot commented Feb 12, 2026

Walkthrough

Moves the toctree index marker (index)= in docs/index.md and adds https://blog.nyrkio.com/ to linkcheck ignore lists in docs/conf.py. No other content or logic changes.

Changes

Cohort / File(s) Summary
Documentation navigation
docs/index.md
Relocated the (index)= toctree index marker from the start of the file to immediately before the CrateDB welcome content, changing the index anchor placement in the TOC.
Linkcheck configuration
docs/conf.py
Added https://blog.nyrkio.com/ to linkcheck_ignore and linkcheck_anchors_ignore_for_url to skip 429/anchor link checks for that domain.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

maintenance, cross linking

Suggested reviewers

  • amotl
  • kneth
  • hlcianfagna

Poem

🐰 I hopped the index, soft and bright,
Placed it where the welcome's light,
Links spared from angry 429s,
I chew the docs and trim the vines,
Hooray — the table hops just right! 🎉

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: fixing linkcheck warnings by addressing an index-related issue in the documentation.
Description check ✅ Passed The description is related to the changeset, explaining that linkcheck warnings caused CI build failures, which aligns with the configuration changes to ignore specific URLs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch bm/fix-index

No actionable comments were generated in the recent review. 🎉


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Member

@amotl amotl left a comment

Choose a reason for hiding this comment

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

🤷

@bmunkholm
Copy link
Contributor Author

Yeah - not a problem IRL. Browsers handle fine.

Another problem related to building is this reoccuring rate-limiting for this article - it's taking forever to build:
(feature/index/index: line 108) ok https://blog.nyrkio.com/wp-content/uploads/2024/07/Nyrkio-comparison-of-CrateDB-and-MongoDB-with-TSBS-v2.pdf
-rate limited- https://blog.nyrkio.com/2024/07/11/timeseries-benchmark-on-cratedb-and-mongodb/ | sleeping...
-rate limited- https://blog.nyrkio.com/2024/07/11/timeseries-benchmark-on-cratedb-and-mongodb/ | sleeping...
-rate limited- https://blog.nyrkio.com/2024/07/11/timeseries-benchmark-on-cratedb-and-mongodb/ | sleeping...
-rate limited- https://blog.nyrkio.com/2024/07/11/timeseries-benchmark-on-cratedb-and-mongodb/ | sleeping...

@bmunkholm bmunkholm merged commit e909353 into main Feb 12, 2026
3 checks passed
@bmunkholm bmunkholm deleted the bm/fix-index branch February 12, 2026 18:34
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.

2 participants