Skip to content

docs: fixed links for deprecated annotations for replacements#1791

Open
AndrewChubatiuk wants to merge 1 commit intomasterfrom
docs-fixed-deprecated-links
Open

docs: fixed links for deprecated annotations for replacements#1791
AndrewChubatiuk wants to merge 1 commit intomasterfrom
docs-fixed-deprecated-links

Conversation

@AndrewChubatiuk
Copy link
Contributor

@AndrewChubatiuk AndrewChubatiuk commented Feb 6, 2026

fixed links for replacements


Summary by cubic

Fixes broken “use X instead” links for deprecated fields in the generated API docs by correcting replacement targets and the docs template. Deprecation hints now point to the right anchors.

  • Bug Fixes
    • Updated docs template to build correct anchors for dotted paths (e.g., externalConfig.secretRef) and show concise link text.
    • Corrected deprecated replacements in annotations:
      • VMAuthSpec.configSecret → externalConfig
      • VMBackup.acceptEULA → VMClusterSpec.license
    • Regenerated docs to update “use … instead” links across VMAuth, VMAgent, VMAlert, VMAlertmanager, and VMAuthLoadBalancer sections.

Written for commit e926791. Summary will update on new commits.

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

No issues found across 4 files

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant