Skip to content

docs: replace broken Vaunt board links - #23805

Open
johnfinnerty-nz wants to merge 2 commits into
pingcap:masterfrom
johnfinnerty-nz:jftc/issue-23746-docs
Open

docs: replace broken Vaunt board links#23805
johnfinnerty-nz wants to merge 2 commits into
pingcap:masterfrom
johnfinnerty-nz:jftc/issue-23746-docs

Conversation

@johnfinnerty-nz

@johnfinnerty-nz johnfinnerty-nz commented Sep 9, 2026

Copy link
Copy Markdown

Summary

Replace obsolete Vaunt community board links with the current Vaunt documentation URL.

Validation

Replacement URL returned HTTP 200; git diff --check passed.

Closes #23746

Summary by CodeRabbit

  • Documentation
    • Renamed the TiDB documentation subsection to “Add a community board badge.”
    • Updated the badge text and links to direct readers to the open-source community documentation.
    • Updated template guidance to use the documentation page as a fallback destination.
    • Removed the outdated bullet linking directly to the community boards page.

Signed-off-by: John Finnerty <297514060+johnfinnerty-nz@users.noreply.github.com>
@ti-chi-bot ti-chi-bot Bot added contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels Sep 9, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 9, 2026

Copy link
Copy Markdown

Hi @johnfinnerty-nz. Thanks for your PR.

I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@ti-chi-bot

ti-chi-bot Bot commented Sep 9, 2026

Copy link
Copy Markdown

Welcome @johnfinnerty-nz!

It looks like this is your first PR to pingcap/docs 🎉.

I'm the bot to help you request reviewers, add labels and more, See available commands.

We want to make sure your contribution gets all the attention it needs!



Thank you, and welcome to pingcap/docs. 😃

@ti-chi-bot ti-chi-bot Bot added the missing-translation-status This PR does not have translation status info. label Sep 9, 2026
@pingcap-cla-assistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@ti-chi-bot

ti-chi-bot Bot commented Sep 9, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign jackysp for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Sep 9, 2026
@coderabbitai

coderabbitai Bot commented Sep 9, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: df30bcee-f6b4-490b-b81c-3d44d441970c

📥 Commits

Reviewing files that changed from the base of the PR and between 79cd093 and 5662c9a.

📒 Files selected for processing (1)
  • .vaunt/add-tidb-docs-dash-badge.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The Vaunt badge instructions now use the Vaunt developer documentation URL. The badge heading and alt text were updated, and the unavailable community-board link was removed.

Changes

Vaunt badge documentation

Layer / File(s) Summary
Update badge instructions
.vaunt/add-tidb-docs-dash-badge.md
The badge heading and alt text were updated. The pingcap and {{github_username}} links now target the Vaunt developer documentation. The community boards bullet was removed, and the documentation URL is described as a fallback.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Severity of issue fixed: Low

Merge Risk: ⚪ Minimal · up to 5662c

The badge instructions now direct users to the current Vaunt documentation instead of unavailable community-board URLs. The change is ready to merge.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the change and validation, but it omits required template information, including affected TiDB versions and contributor or change-scope checkboxes. Add the required affected TiDB version selection and complete the applicable template sections, including related links, contributor checklist, AI involvement, and change-scope declarations.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the primary change: replacing broken Vaunt board links.
Linked Issues check ✅ Passed The changes update the broken Vaunt URL identified in issue [#23746] and replace related obsolete community-board links with the current documentation URL.
Out of Scope Changes check ✅ Passed All changes are limited to Vaunt community-board link updates in the file identified by issue [#23746]. No unrelated changes are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
  • Fix all pre-merge checks with AI
✨ 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.

Signed-off-by: John Finnerty <297514060+johnfinnerty-nz@users.noreply.github.com>
@ti-chi-bot ti-chi-bot Bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. missing-translation-status This PR does not have translation status info. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken Link Detected

1 participant