Skip to content

tidb-cloud: use the full Terraform resource name in the private endpoint connection link text - #24581

Open
yahonda wants to merge 1 commit into
pingcap:masterfrom
yahonda:tidb-cloud-terraform-private-endpoint-link-text
Open

yahonda wants to merge 1 commit into
pingcap:masterfrom
yahonda:tidb-cloud-terraform-private-endpoint-link-text

Conversation

@yahonda

@yahonda yahonda commented Oct 29, 2026 •

Copy link
Copy Markdown
Member

What is changed, added, or deleted? (Required)

In tidb-cloud/terraform-use-dedicated-private-endpoint-connection-resource.md, the link text for the Terraform Registry page says tidbcloud_private_endpoint_connection, but the resource name is tidbcloud_dedicated_private_endpoint_connection. The example in the same document, the resource type in the list, and the link URL (.../resources/dedicated_private_endpoint_connection) all use the dedicated_ name. A reader who copies the name from the link text gets a resource type that does not exist.

This PR changes the link text to tidbcloud_dedicated_private_endpoint_connection (Resource). The URL is unchanged.

The same line exists on release-8.5.

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

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 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)?

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

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the Terraform Registry link in the dedicated private endpoint connection instructions.

…int connection link text

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ti-chi-bot

ti-chi-bot Bot commented Oct 29, 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 csuzhangxc 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 Oct 29, 2026
@coderabbitai

coderabbitai Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: pingcap/docs
  • Branch: master
  • File: .coderabbit.yaml
  • Commit: e5e80ae
  • Layers: Repository YAML
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: c2945d13-8f72-4b01-ba0c-cd69c141a2ff
Commits

Reviewing files that changed from the base of the PR and between e5e80ae and 83838c4.

Files selected for processing: 1
  • tidb-cloud/terraform-use-dedicated-private-endpoint-connection-resource.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 2 remain after this review.

Walkthrough

The Terraform creation instructions now name tidbcloud_dedicated_private_endpoint_connection in the resource-specification link text. The link URL is unchanged.

Changes: Terraform documentation

Layer / File(s) Summary
Update resource link text
tidb-cloud/terraform-use-dedicated-private-endpoint-connection-resource.md
The resource-specification link text now names tidbcloud_dedicated_private_endpoint_connection. The URL is unchanged.

Priority: Low

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

Change: Other

Suggested reviewers: qiancai

Merge Risk: Minimal · up to 83838

No actionable merge risk remains in this documentation-only change.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly identifies the main change: using the full Terraform resource name in the private endpoint connection link text.
Description check Passed The description explains the change, affected versions, motivation, reference, AI involvement, and applicable change categories. It is complete for this documentation-only update.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
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.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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