Skip to content

docs: fix broken and redirected links from link checker report - #2661

Open
eschabell wants to merge 1 commit into
fluent:masterfrom
eschabell:erics_linkchecker_report_fixes
Open

docs: fix broken and redirected links from link checker report#2661
eschabell wants to merge 1 commit into
fluent:masterfrom
eschabell:erics_linkchecker_report_fixes

Conversation

@eschabell

@eschabell eschabell commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator

The monthly link checker reported 3 errors, 1 timeout, and 27 redirects.
Fix the two genuine 404s, correct a citation that silently redirected to
the wrong API, resolve the redirects worth resolving, and stop LinkedIn
from generating a false error every month.

Broken links (404):

  • pipeline/outputs/azure_kusto.md: repoint "Authorize the app in your database" at learn.microsoft.com/en-us/kusto/management/reference- security-principals. The old URL 404s, and Microsoft's own redirect from it lands on another 404. The new page carries the aadapp=ApplicationId;TenantId syntax the step refers to.
  • pipeline/outputs/s3.md: drop the link on the timer callback. It pointed at the AWS IoT Events Data API Timer data type, which is unrelated to S3 or to Fluent Bit. The S3 upload timer is the internal cb_s3_upload scheduler callback and has no external documentation, so there is no correct replacement URL. Keep timer as inline code.

Stale citation (redirected to unrelated content):

  • pipeline/outputs/bigquery.md: the data deduplication and template tables bullets cited the legacy streaming page, which Google now redirects to the Storage Write API. That page documents neither insertId nor templateSuffix. Cite the tabledata.insertAll REST reference instead, which documents both.

Redirects resolved:

  • CONTRIBUTING.md: vale.sh/docs to docs.vale.sh, drop the trailing slash on docs.fluentbit.io/manual, and update the Microsoft smart quotes support URL.
  • MAINTAINERS.md: telemetryforge.io to www.telemetryforge.io, and re-pad the table cell so the pipe alignment still holds.
  • README.md: drop the trailing slash on the LinkedIn profile URL.
  • development/external-libraries.md, development/wasm-filter-plugins.md: wasm-micro-runtime moved out of the bytecodealliance org to its own. The project is still a Bytecode Alliance project, so only the URL changes.
  • pipeline/filters/tensorflow.md: ai.google.dev/edge/litert to developers.google.com/edge/litert (2 links).
  • pipeline/outputs/bigquery.md, pipeline/outputs/chronicle.md: cloud.google.com to docs.cloud.google.com.
  • pipeline/outputs/forward.md: fluentd.org to www.fluentd.org (3 links).
  • pipeline/outputs/influxdb.md: add the trailing slash on the InfluxDB product URL.

Link checker configuration:

  • .github/workflows/linkcheck.yaml: accept HTTP 999. LinkedIn returns it to non-browser clients, so the README profile link is reported as an error every run even though it resolves fine. Accepting 999 is narrower than excluding linkedin.com and keeps the URL checked for DNS and host failures.

Deliberately unchanged: the asciinema link in pipeline/inputs/http.md,
which timed out in CI but resolves normally; the Dynatrace shortlink,
where expanding it to the resolved deep path would be more fragile; the
three fluent-bit issue template links, which only redirect because the
checker is unauthenticated; and the RFC Editor, GitHub codeload, Datadog,
Treasure Data, Docker, and ECR redirects, which are correct as written.

Fixes #2652

Summary by CodeRabbit

  • Documentation

    • Updated project, contribution, maintainer, and integration documentation links to current destinations.
    • Refreshed links for WAMR, TensorFlow Lite, Azure Kusto, BigQuery, Chronicle, Fluentd, InfluxDB, and related services.
    • Removed an outdated AWS Timer API hyperlink from the S3 documentation.
  • Chores

    • Improved automated link checking to recognize HTTP 999 responses as acceptable.

@eschabell eschabell self-assigned this Aug 5, 2026
@eschabell
eschabell requested a review from a team as a code owner August 5, 2026 14:21
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0.9 labels Aug 5, 2026
@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 3b3e114a-7bcd-4d8f-9624-34e604097b37

📥 Commits

Reviewing files that changed from the base of the PR and between 7e95f3a and d3a7139.

📒 Files selected for processing (13)
  • .github/workflows/linkcheck.yaml
  • CONTRIBUTING.md
  • MAINTAINERS.md
  • README.md
  • development/external-libraries.md
  • development/wasm-filter-plugins.md
  • pipeline/filters/tensorflow.md
  • pipeline/outputs/azure_kusto.md
  • pipeline/outputs/bigquery.md
  • pipeline/outputs/chronicle.md
  • pipeline/outputs/forward.md
  • pipeline/outputs/influxdb.md
  • pipeline/outputs/s3.md
🚧 Files skipped from review as they are similar to previous changes (10)
  • pipeline/outputs/chronicle.md
  • .github/workflows/linkcheck.yaml
  • pipeline/outputs/bigquery.md
  • development/wasm-filter-plugins.md
  • pipeline/outputs/forward.md
  • MAINTAINERS.md
  • pipeline/outputs/s3.md
  • pipeline/outputs/influxdb.md
  • CONTRIBUTING.md
  • development/external-libraries.md

📝 Walkthrough

Walkthrough

The workflow now accepts status code 999. Documentation links across project, development, and pipeline pages were updated. An obsolete AWS timer hyperlink was removed.

Changes

Documentation and link-check updates

Layer / File(s) Summary
Link-check status configuration
.github/workflows/linkcheck.yaml
Lychee now accepts HTTP status code 999.
Project and development links
CONTRIBUTING.md, MAINTAINERS.md, README.md, development/*.md
Contributor, maintainer, sponsorship, and WebAssembly documentation URLs were updated.
Pipeline documentation links
pipeline/filters/tensorflow.md, pipeline/outputs/*.md
External service links were updated. The obsolete AWS timer hyperlink was removed.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested reviewers: patrick-stephens

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the documentation link fixes and link-checker changes.
Linked Issues check ✅ Passed The changes address issue #2652 by fixing reported errors, updating canonical URLs, and accepting HTTP 999 without changing the timeout.
Out of Scope Changes check ✅ Passed All changes relate to the link-checker report, documentation URLs, or required link-checker configuration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@pipeline/filters/tensorflow.md`:
- Line 9: Update the Tensorflow Lite description to hyphenate “open-source” when
it modifies “deep learning framework,” without changing the surrounding wording.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: e7110596-2342-419d-b767-b2d71e4e2043

📥 Commits

Reviewing files that changed from the base of the PR and between 7e95f3a and 2d0bf11.

📒 Files selected for processing (13)
  • .github/workflows/linkcheck.yaml
  • CONTRIBUTING.md
  • MAINTAINERS.md
  • README.md
  • development/external-libraries.md
  • development/wasm-filter-plugins.md
  • pipeline/filters/tensorflow.md
  • pipeline/outputs/azure_kusto.md
  • pipeline/outputs/bigquery.md
  • pipeline/outputs/chronicle.md
  • pipeline/outputs/forward.md
  • pipeline/outputs/influxdb.md
  • pipeline/outputs/s3.md

Comment thread pipeline/filters/tensorflow.md
@eschabell
eschabell force-pushed the erics_linkchecker_report_fixes branch from 2d0bf11 to 92e406a Compare August 5, 2026 14:39
@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

@eschabell
eschabell force-pushed the erics_linkchecker_report_fixes branch from 92e406a to 80d2736 Compare August 5, 2026 14:49
@eschabell

Copy link
Copy Markdown
Collaborator Author

@patrick-stephens ready for review!

@eschabell
eschabell force-pushed the erics_linkchecker_report_fixes branch from 80d2736 to 95c640a Compare August 5, 2026 15:40
@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@pipeline/outputs/azure_kusto.md`:
- Line 7: Update the Eventhouse link in the Kusto output plugin documentation to
use the canonical Microsoft Learn Eventhouse overview at
learn.microsoft.com/en-us/fabric/real-time-intelligence/eventhouse, while
preserving the surrounding description and other links.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 224df8ae-533e-4abd-8fe1-3fc90437936f

📥 Commits

Reviewing files that changed from the base of the PR and between 7e95f3a and 95c640a.

📒 Files selected for processing (13)
  • .github/workflows/linkcheck.yaml
  • CONTRIBUTING.md
  • MAINTAINERS.md
  • README.md
  • development/external-libraries.md
  • development/wasm-filter-plugins.md
  • pipeline/filters/tensorflow.md
  • pipeline/outputs/azure_kusto.md
  • pipeline/outputs/bigquery.md
  • pipeline/outputs/chronicle.md
  • pipeline/outputs/forward.md
  • pipeline/outputs/influxdb.md
  • pipeline/outputs/s3.md
🚧 Files skipped from review as they are similar to previous changes (10)
  • CONTRIBUTING.md
  • pipeline/outputs/forward.md
  • pipeline/outputs/bigquery.md
  • pipeline/outputs/s3.md
  • pipeline/outputs/chronicle.md
  • MAINTAINERS.md
  • development/external-libraries.md
  • pipeline/outputs/influxdb.md
  • .github/workflows/linkcheck.yaml
  • development/wasm-filter-plugins.md

Comment thread pipeline/outputs/azure_kusto.md Outdated
  The monthly link checker reported 3 errors, 1 timeout, and 27 redirects.
  Fix the two genuine 404s, correct a citation that silently redirected to
  the wrong API, resolve the redirects worth resolving, and stop LinkedIn
  from generating a false error every month.

  Broken links (404):

  - pipeline/outputs/azure_kusto.md: repoint "Authorize the app in your
    database" at learn.microsoft.com/en-us/kusto/management/reference-
    security-principals. The old URL 404s, and Microsoft's own redirect
    from it lands on another 404. The new page carries the
    aadapp=ApplicationId;TenantId syntax the step refers to. Also fixed
    broken Eventhouse link.
  - pipeline/outputs/s3.md: drop the link on the `timer` callback. It
    pointed at the AWS IoT Events Data API Timer data type, which is
    unrelated to S3 or to Fluent Bit. The S3 upload timer is the internal
    cb_s3_upload scheduler callback and has no external documentation, so
    there is no correct replacement URL. Keep `timer` as inline code.

  Stale citation (redirected to unrelated content):

  - pipeline/outputs/bigquery.md: the data deduplication and template
    tables bullets cited the legacy streaming page, which Google now
    redirects to the Storage Write API. That page documents neither
    insertId nor templateSuffix. Cite the tabledata.insertAll REST
    reference instead, which documents both.

  Redirects resolved:

  - CONTRIBUTING.md: vale.sh/docs to docs.vale.sh, drop the trailing slash
    on docs.fluentbit.io/manual, and update the Microsoft smart quotes
    support URL.
  - MAINTAINERS.md: telemetryforge.io to www.telemetryforge.io, and
    re-pad the table cell so the pipe alignment still holds.
  - README.md: drop the trailing slash on the LinkedIn profile URL.
  - development/external-libraries.md, development/wasm-filter-plugins.md:
    wasm-micro-runtime moved out of the bytecodealliance org to its own.
    The project is still a Bytecode Alliance project, so only the URL
    changes.
  - pipeline/filters/tensorflow.md: ai.google.dev/edge/litert to
    developers.google.com/edge/litert (2 links).
  - pipeline/outputs/bigquery.md, pipeline/outputs/chronicle.md:
    cloud.google.com to docs.cloud.google.com.
  - pipeline/outputs/forward.md: fluentd.org to www.fluentd.org (3 links).
  - pipeline/outputs/influxdb.md: add the trailing slash on the InfluxDB
    product URL.
  - pipeline/outputs/azure_kusto.md: update moved Eventhouse blog link.

  Link checker configuration:

  - .github/workflows/linkcheck.yaml: accept HTTP 999. LinkedIn returns it
    to non-browser clients, so the README profile link is reported as an
    error every run even though it resolves fine. Accepting 999 is
    narrower than excluding linkedin.com and keeps the URL checked for
    DNS and host failures.

  Deliberately unchanged: the asciinema link in pipeline/inputs/http.md,
  which timed out in CI but resolves normally; the Dynatrace shortlink,
  where expanding it to the resolved deep path would be more fragile; the
  three fluent-bit issue template links, which only redirect because the
  checker is unauthenticated; and the RFC Editor, GitHub codeload, Datadog,
  Treasure Data, Docker, and ECR redirects, which are correct as written.

  Fixes fluent#2652

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell
eschabell force-pushed the erics_linkchecker_report_fixes branch from 95c640a to d3a7139 Compare August 5, 2026 19:21
@eschabell

Copy link
Copy Markdown
Collaborator Author

@patrick-stephens ready for review!

@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

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

Labels

5.0.9 waiting-on-review Waiting on a review from mainteners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Link Checker Report

1 participant