Skip to content

📖 fix broken catalod api reference link - #2152

Merged
openshift-merge-bot[bot] merged 2 commits into
operator-framework:mainfrom
anik120:fix-broken-api-ref-link
Aug 20, 2025
Merged

📖 fix broken catalod api reference link#2152
openshift-merge-bot[bot] merged 2 commits into
operator-framework:mainfrom
anik120:fix-broken-api-ref-link

Conversation

@anik120

@anik120anik120 commented Aug 19, 2025

Copy link
Copy Markdown
Member

The make target crd-ref-docs generates the api reference doc operator-controller-api-reference.md using the API types in the api/ directory.
The docs structure was expecting two files, while only one file was being generated.

This PR fixes the doc structure to expect only one file, getting rid of a broken link as a result.

Description

Reviewer Checklist

  • API Go Documentation
  • Tests: Unit Tests (and E2E Tests, if appropriate)
  • Comprehensive Commit Messages
  • Links to related GitHub Issue(s)

The make target `crd-ref-docs` generates the api reference doc
operator-controller-api-reference.md using the API types in the
`api/` directory.
The docs structure was expecting two files, while only one file
was being generated.
This PR fixes the doc structure to expect only one file, getting
rid of a broken link as a result.
@anik120
anik120 requested a review from a team as a code ownerAugust 19, 2025 18:06
@netlify

netlifyBot commented Aug 19, 2025

Copy link
Copy Markdown

Deploy Preview for olmv1 ready!

NameLink
🔨 Latest commit0979e4d
🔍 Latest deploy loghttps://app.netlify.com/projects/olmv1/deploys/68a4bfe465d2ca000842df05
😎 Deploy Previewhttps://deploy-preview-2152--olmv1.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@grokspawn

grokspawn commented Aug 19, 2025

Copy link
Copy Markdown
Contributor

IMHO, if we're going to drop discrete operator-controller / catalogd nomenclature w.r.t. the API docs, then we should consistently refer to it as "OLMv1 API", not "operator-controller", like here.

@anik120

Copy link
Copy Markdown
MemberAuthor

IMHO, if we're going to drop discrete operator-controller / catalogd nomenclature w.r.t. the API docs, then we should consistently refer to it as "OLMv1 API", not "operator-controller", like here.

@grokspawn that is totally fair. Pushed a new commit renaming that part. PTAL.

@codecov

codecovBot commented Aug 19, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 72.83%. Comparing base (35bcd7a) to head (0979e4d).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #2152 +/- ##
==========================================
+ Coverage 72.75% 72.83% +0.08% 
==========================================
Files 79 79 Lines 7340 7340 ==========================================
+ Hits 5340 5346 +6 + Misses 1653 1649 -4 + Partials 347 345 -2 
FlagCoverage Δ
e2e44.43% <ø> (?)
experimental-e2e55.16% <ø> (+0.24%)⬆️
unit58.24% <ø> (+0.01%)⬆️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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

@grokspawn

Copy link
Copy Markdown
Contributor

/lgtm
(I have no approver powers in this repo)

@openshift-ciopenshift-ciBot added the lgtm Indicates that a PR is ready to be merged. label Aug 19, 2025
@grokspawn

Copy link
Copy Markdown
Contributor

still some warnings in the workflow
Would you please capture an issue for these in the backlog, @anik120?
(Ideally, the CI would fail on warnings.)

@grokspawn

Copy link
Copy Markdown
Contributor

Ooh. First time we've had a PR with contributions across api, Makefile, docs areas, so I'm curious to see how the new ladder works.

/approve

@grokspawn

Copy link
Copy Markdown
Contributor

Ladder works. 😁

@openshift-ci

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: grokspawn, perdasilva

The full list of commands accepted by this bot can be found here.

The pull request process is described 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

@openshift-ciopenshift-ciBot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 20, 2025
@openshift-merge-bot
openshift-merge-botBot merged commit 528b321 into operator-framework:mainAug 20, 2025
24 checks passed
@anik120

Copy link
Copy Markdown
MemberAuthor

still some warnings in the workflow Would you please capture an issue for these in the backlog, @anik120? (Ideally, the CI would fail on warnings.)

@grokspawn#2157

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

Labels

approvedIndicates a PR has been approved by an approver from all required OWNERS files.lgtmIndicates that a PR is ready to be merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@anik120@grokspawn@perdasilva