📖 fix broken catalod api reference link #2152
Conversation
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.
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
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 Report✅ All modified and coverable lines are covered by tests. 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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
/lgtm |
|
still some warnings in the workflow |
|
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 |
|
Ladder works. 😁 |
|
[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
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
528b321
into
operator-framework:main
The make target
crd-ref-docsgenerates the api reference docoperator-controller-api-reference.mdusing the API types in theapi/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