Skip to content

Conversation

@amotl
Copy link
Member

@amotl amotl commented Dec 13, 2025

Just maintenance.

  • Fix link to Telegraf architecture diagram
  • Ignore failing link dlthub.com
Restorations

image

-- https://web.archive.org/web/20240808081907/https://www.influxdata.com/wp-content/uploads/Main-Diagram_06.01.2022v1.png

@coderabbitai
Copy link

coderabbitai bot commented Dec 13, 2025

Walkthrough

Adds https://dlthub.com/ to the Sphinx linkcheck ignore list and updates the Telegraf integration page to use a different image source URL (a GitHub user-attachments URL with loading="lazy"). No behavioral code changes.

Changes

Cohort / File(s) Summary
Configuration update
docs/conf.py
Added https://dlthub.com/ to linkcheck_ignore with a comment noting a 500 Internal Server Error.
Docs image update
docs/integrate/telegraf/index.md
Replaced the Telegraf architecture overview image source with a GitHub user-attachments URL and added loading="lazy" to the image markup.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested labels

cross linking, maintenance

Suggested reviewers

  • bmunkholm
  • zolbatar

Poem

🐰 A nibble of links, a tweak to the view,
Images now lazing, URLs skip through,
Quiet changes hopped into place,
Docs tidy and bright, with a carrot-shaped grace. 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Fix broken links 2025-12a' directly describes the main change in the PR - fixing broken documentation links (Telegraf diagram and dlthub.com URL ignoring).
Description check ✅ Passed The description clearly relates to the changeset, detailing the two specific link fixes (Telegraf architecture diagram and dlthub.com) and providing context with archived references.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ 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 fix-broken-links-2025-12a

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 15d62bd and b1e92a7.

📒 Files selected for processing (2)
  • docs/conf.py (1 hunks)
  • docs/integrate/telegraf/index.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/integrate/telegraf/index.md
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: bmunkholm
Repo: crate/cratedb-guide PR: 340
File: docs/home/index.md:84-97
Timestamp: 2025-09-25T19:31:54.320Z
Learning: In the CrateDB Guide docs (MyST), the CrateDB Cloud card on the homepage should link to `getting-started` using `:link-type: ref` instead of the previous `cloud:index` intersphinx target. This change was implemented in PR #340 to direct users to the getting started section rather than directly to the Cloud documentation.
Learnt from: amotl
Repo: crate/cratedb-guide PR: 395
File: docs/install/cloud/azure/terraform.md:108-127
Timestamp: 2025-10-10T17:58:26.545Z
Learning: In the crate/cratedb-guide repository, during documentation format conversions (e.g., from reStructuredText to MyST/Markdown), markdownlint warnings such as MD053 (unused reference-style links) should be ignored and not flagged as issues.
Learnt from: amotl
Repo: crate/cratedb-guide PR: 236
File: docs/index.md:312-316
Timestamp: 2025-08-09T11:00:03.578Z
Learning: In the CrateDB Guide documentation, locally stale references (such as `(reference-architectures)=`, `(domain)=`, and similar anchor labels) should be retained even when they appear unused within the repository, as external projects might still reference them. This ensures backward compatibility for external documentation and projects.
📚 Learning: 2025-08-14T12:52:11.962Z
Learnt from: amotl
Repo: crate/cratedb-guide PR: 248
File: docs/conf.py:64-66
Timestamp: 2025-08-14T12:52:11.962Z
Learning: In documentation repositories, avoid over-engineering simple solutions like linkcheck ignore patterns. Simple, working patterns are often preferable to comprehensive regex patterns that handle all edge cases, especially when the simpler version is already functioning correctly.

Applied to files:

  • docs/conf.py
📚 Learning: 2025-10-10T17:58:26.545Z
Learnt from: amotl
Repo: crate/cratedb-guide PR: 395
File: docs/install/cloud/azure/terraform.md:108-127
Timestamp: 2025-10-10T17:58:26.545Z
Learning: In the crate/cratedb-guide repository, during documentation format conversions (e.g., from reStructuredText to MyST/Markdown), markdownlint warnings such as MD053 (unused reference-style links) should be ignored and not flagged as issues.

Applied to files:

  • docs/conf.py
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Build docs

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.

@amotl amotl force-pushed the fix-broken-links-2025-12a branch from 20c1748 to 6febf78 Compare December 13, 2025 20:44
@amotl amotl changed the title Fix link to Telegraf architecture diagram Fix broken links 2025-12a Dec 13, 2025
@amotl amotl marked this pull request as ready for review December 13, 2025 20:48
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3c49578 and 15d62bd.

📒 Files selected for processing (2)
  • docs/conf.py (1 hunks)
  • docs/integrate/telegraf/index.md (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: bmunkholm
Repo: crate/cratedb-guide PR: 340
File: docs/home/index.md:84-97
Timestamp: 2025-09-25T19:31:54.320Z
Learning: In the CrateDB Guide docs (MyST), the CrateDB Cloud card on the homepage should link to `getting-started` using `:link-type: ref` instead of the previous `cloud:index` intersphinx target. This change was implemented in PR #340 to direct users to the getting started section rather than directly to the Cloud documentation.
Learnt from: amotl
Repo: crate/cratedb-guide PR: 395
File: docs/install/cloud/azure/terraform.md:108-127
Timestamp: 2025-10-10T17:58:26.545Z
Learning: In the crate/cratedb-guide repository, during documentation format conversions (e.g., from reStructuredText to MyST/Markdown), markdownlint warnings such as MD053 (unused reference-style links) should be ignored and not flagged as issues.
Learnt from: amotl
Repo: crate/cratedb-guide PR: 236
File: docs/index.md:312-316
Timestamp: 2025-08-09T11:00:03.578Z
Learning: In the CrateDB Guide documentation, locally stale references (such as `(reference-architectures)=`, `(domain)=`, and similar anchor labels) should be retained even when they appear unused within the repository, as external projects might still reference them. This ensures backward compatibility for external documentation and projects.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Build docs

@amotl amotl force-pushed the fix-broken-links-2025-12a branch from 15d62bd to b1e92a7 Compare December 13, 2025 20:57
@amotl amotl added the maintenance C'est la vie. label Dec 13, 2025
@amotl amotl merged commit b60a1dd into main Dec 13, 2025
3 checks passed
@amotl amotl deleted the fix-broken-links-2025-12a branch December 13, 2025 21:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance C'est la vie.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants