Skip to content

clinic: fix config.json described as a directory instead of a file - #23836

Open
yahonda wants to merge 1 commit into
pingcap:release-8.5from
yahonda:fix-en-config-json-file-wording
Open

clinic: fix config.json described as a directory instead of a file#23836
yahonda wants to merge 1 commit into
pingcap:release-8.5from
yahonda:fix-en-config-json-file-wording

Conversation

@yahonda

@yahonda yahonda commented Sep 11, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

"Configuration data: in the `config.json` directory of each node" incorrectly calls `config.json` a directory. `clinic-data-instruction-for-tiup.md` in this same repo documents `config.json` as the per-component "Real-time configuration" file (e.g. for TiDB, TiKV, PD, TiFlash), consistent with its `.json` extension.

Source-code verification: in the `pingcap/diag` (Clinic/tiup diag) source, `collector/config.go` builds a `configs` list of `rtConfig{"config.json", ...}` entries per component, then downloads each one to `filepath.Join(resultDir, host, instDir, "conf", config.filename)` — i.e. `config.json` is written out as a literal file at `.../conf/config.json` under each node's own subdirectory, confirming it is a file, not a directory.

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

config.json has a .json extension and is documented elsewhere
(clinic-data-instruction-for-tiup.md) as the per-component
"Real-time configuration" file, not a directory.
@ti-chi-bot

ti-chi-bot Bot commented Sep 11, 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 tangenta 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 missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 11, 2026
@coderabbitai

coderabbitai Bot commented Sep 11, 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: d1ae21bf-8c3b-4d56-8a24-de786325c0a4

📥 Commits

Reviewing files that changed from the base of the PR and between 8d85871 and 17c2a2f.

📒 Files selected for processing (1)
  • clinic/clinic-user-guide-for-tiup.md

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


📝 Walkthrough

Walkthrough

The clinic user guide now states that configuration data is stored in each node's config.json file.

Changes

Clinic user guide

Layer / File(s) Summary
Correct configuration storage path
clinic/clinic-user-guide-for-tiup.md
Step 3 now identifies the configuration data location as the config.json file under each node's directory.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 17c2a

The guide now correctly identifies config.json as a per-node configuration file, with no runtime impact.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The description explains the documentation correction, identifies the applicable TiDB version, provides supporting references, records AI involvement, and addresses the change-category checklist. It i…
Title check ✅ Passed The title clearly and concisely describes the main change: correcting config.json from a directory description to a file description.
✨ 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.

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

Labels

missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant