Skip to content

docs: link default_branch deprecation notice to github_branch_default resource#3544

Open
leo-lem wants to merge 1 commit into
integrations:mainfrom
leo-lem:docs-link-default-branch
Open

docs: link default_branch deprecation notice to github_branch_default resource#3544
leo-lem wants to merge 1 commit into
integrations:mainfrom
leo-lem:docs-link-default-branch

Conversation

@leo-lem

@leo-lem leo-lem commented Jul 15, 2026

Copy link
Copy Markdown

Summary

  • Links the github_branch_default mention in the default_branch deprecation note (both the docs template and generated docs) to its full registry URL, so it reads clearly as a resource rather than a parameter.

Fixes #2716

Test plan

  • make generatedocs regenerates docs/resources/repository.md from the template with no other diffs
  • tfplugindocs validate passes

🤖 Generated with Claude Code

…ation notice

Fixes integrations#2716 — the deprecation note was easy to misread as referring to a
resource parameter rather than the github_branch_default resource itself.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 15, 2026 17:37
@github-actions

Copy link
Copy Markdown

👋 Hi, and thank you for this contribution!

This repo is maintained by GitHub and community members on a best-effort basis. We'll get to this as soon as we can.

You can help us prioritize by joining the discussion on open issues and PRs, sharing details on the changes you need, and reviewing other contributions.


🤖 This is an automated message.

@github-actions github-actions Bot added the Type: Documentation Improvements or additions to documentation label Jul 15, 2026

Copilot AI 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.

Pull request overview

These provider review instructions are being used. This docs-only PR links the deprecated default_branch argument to its replacement resource.

Changes:

  • Adds the resource link to the documentation template.
  • Keeps generated documentation synchronized.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
templates/resources/repository.md.tmpl Links to github_branch_default.
docs/resources/repository.md Updates generated documentation.

@leo-lem leo-lem closed this Jul 15, 2026
@leo-lem leo-lem deleted the docs-link-default-branch branch July 15, 2026 17:38
@leo-lem leo-lem restored the docs-link-default-branch branch July 15, 2026 17:38
@leo-lem leo-lem reopened this Jul 15, 2026
@deiga

deiga commented Jul 15, 2026

Copy link
Copy Markdown
Collaborator

Thanks for creating this!
There is a large refactor of this are coming in #3310, so I would suggest waiting until that is merged or then I could add a similar change to that PR

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

Labels

Type: Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS]: github_branch_default resource with an inline link

3 participants