Skip to content

fix: Correct EnterpriseContractPolicy documentation link#3215

Open
dheerajodha wants to merge 2 commits intoconforma:mainfrom
dheerajodha:EC-1650
Open

fix: Correct EnterpriseContractPolicy documentation link#3215
dheerajodha wants to merge 2 commits intoconforma:mainfrom
dheerajodha:EC-1650

Conversation

@dheerajodha
Copy link
Copy Markdown
Contributor

  • Fixed broken documentation link for EnterpriseContractPolicy in configuration docs
  • Link was pointing to CLI reference instead of ECC API reference
  • Now includes direct anchor to EnterpriseContractPolicy section

resolves: EC-1650

The link to EnterpriseContractPolicy in the configuration docs was
pointing to the CLI reference page instead of the ECC API reference.
Updated to point to the correct API documentation with a direct
anchor to the EnterpriseContractPolicy section.

resolves: EC-1650

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 31, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 73f7a8ef-a506-4c2f-b8d3-9c0756ec695d

📥 Commits

Reviewing files that changed from the base of the PR and between da87ab2 and 5c7842c.

📒 Files selected for processing (1)
  • docs/modules/ROOT/pages/configuration.adoc
✅ Files skipped from review due to trivial changes (1)
  • docs/modules/ROOT/pages/configuration.adoc

📝 Walkthrough

Walkthrough

Updated an AsciiDoc cross-reference in the configuration documentation: the EnterpriseContractPolicy xref target was changed from the CLI module to the ECC module using a specific anchor, with link text and surrounding content unchanged.

Changes

Cohort / File(s) Summary
Documentation Link Update
docs/modules/ROOT/pages/configuration.adoc
Replaced the EnterpriseContractPolicy xref target xref:cli:ROOT:reference.adoc[EnterpriseContractPolicy] with xref:ecc:ROOT:reference.adoc#k8s-api-github-com-enterprise-contract-enterprise-contract-controller-api-v1alpha1-enterprisecontractpolicy[EnterpriseContractPolicy]; displayed text and context unchanged.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title directly and clearly summarizes the main change: correcting a broken documentation link for EnterpriseContractPolicy.
Description check ✅ Passed The description is related to the changeset, providing context about the broken link fix, the reason for the change, and the issue reference.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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 and usage tips.

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 31, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

Flag Coverage Δ
acceptance 55.16% <ø> (-0.01%) ⬇️
generative 17.90% <ø> (ø)
integration 26.63% <ø> (ø)
unit 69.01% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

st3penta
st3penta previously approved these changes Mar 31, 2026
simonbaird
simonbaird previously approved these changes Apr 1, 2026
Copy link
Copy Markdown
Member

@simonbaird simonbaird left a comment

Choose a reason for hiding this comment

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

Lgtm, but consider my suggestions.

@dheerajodha dheerajodha dismissed stale reviews from simonbaird and st3penta via 5c7842c April 2, 2026 12:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants