-
Notifications
You must be signed in to change notification settings - Fork 68
📖 Update .spec.config api doc to direct users to docs #2383
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
📖 Update .spec.config api doc to direct users to docs #2383
Conversation
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR updates the API documentation for the .spec.config field in the ClusterExtension API to provide clearer guidance on bundle configuration and direct users to the OLM documentation.
Key Changes:
- Updates the behavior description when a bundle doesn't provide a configuration schema from "manifests will be derived on a best-effort basis" to "the bundle is deemed to not be configurable"
- Redirects users from bundle-specific end-user documentation to the OLM documentation for configuration guidance
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
api/v1/clusterextension_types.go |
Updates the Go API documentation for the Config field to clarify behavior and documentation reference |
helm/olmv1/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterextensions.yaml |
Updates the CRD manifest documentation to match the Go API changes |
manifests/experimental.yaml |
Updates the experimental manifest documentation to match the Go API changes |
manifests/experimental-e2e.yaml |
Updates the E2E experimental manifest documentation to match the Go API changes |
The documentation updates are consistent across all files and improve clarity for users by providing a more accurate description of the behavior and directing them to centralized OLM documentation rather than bundle-specific documentation. No issues were identified in this PR.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2383 +/- ##
==========================================
+ Coverage 73.05% 73.10% +0.05%
==========================================
Files 100 100
Lines 7641 7641
==========================================
+ Hits 5582 5586 +4
+ Misses 1623 1621 -2
+ Partials 436 434 -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:
|
Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>
5ef68f5 to
5a2a49e
Compare
pedjak
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: pedjak The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
39718ba
into
operator-framework:main
Description
Makes a small update to the
.spec.configdocs to direct users to OLM documentation for more information on configuring bundles.Reviewer Checklist