NO-JIRA: Mention the fauxinnati in the developer documentation#1308
NO-JIRA: Mention the fauxinnati in the developer documentation#1308openshift-merge-bot[bot] merged 2 commits intoopenshift:mainfrom
Conversation
It is so cool and thus worth a paragraph in our docs for it. Then it will be our responsibility to maintain the tool since it is public which should not increase any security risks because the tool is accessible by anyone already.
openshift-ci
Bot
added
the
approved
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review infoConfiguration used: Repository: openshift/coderabbit/.coderabbit.yaml Review profile: CHILL Plan: Pro Cache: Disabled due to data retention organization setting Knowledge base: Disabled due to data retention organization setting 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughUpdated the feed-cvo-custom-graphs documentation to add fauxinnati example and demo references, expand hosting guidance with a concrete git-based workflow (branch creation, Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/dev/feed-cvo-custom-graphs.md`:
- Line 31: The documentation uses an inconsistent field reference
`cv.spec.upstream`; update the example text to reference the correct Kubernetes
resource field name (use `spec.upstream` or the fully-qualified
`clusterversion.spec.upstream`) so readers can find the right field; replace
`cv.spec.upstream` with `spec.upstream` (or `clusterversion.spec.upstream`) in
the sentence and ensure any surrounding examples/comments use the same corrected
symbol.
| } | ||
| ``` | ||
|
|
||
| More examples can be found at [fauxinnati](https://fauxinnati-fauxinnati.apps.ota-stage.q2z4.p1.openshiftapps.com/). See [a demo](https://asciinema.org/a/hUwpV4pyhGK0k0nI68KzAO3pv) to use it as `cv.spec.upstream`. It currently does not inject real payload URLs, and thus we cannot do a cluster upgrade with it. We may modify the returned graph and host it somewhere (see the example in this page) to achieve it. |
There was a problem hiding this comment.
Fix the field reference in the example.
cv.spec.upstream looks like a typo; readers are likely to look for spec.upstream (or clusterversion.spec.upstream).
✏️ Proposed text fix
-More examples can be found at [fauxinnati](https://fauxinnati-fauxinnati.apps.ota-stage.q2z4.p1.openshiftapps.com/). See [a demo](https://asciinema.org/a/hUwpV4pyhGK0k0nI68KzAO3pv) to use it as `cv.spec.upstream`. It currently does not inject real payload URLs, and thus we cannot do a cluster upgrade with it. We may modify the returned graph and host it somewhere (see the example in this page) to achieve it.
+More examples can be found at [fauxinnati](https://fauxinnati-fauxinnati.apps.ota-stage.q2z4.p1.openshiftapps.com/). See [a demo](https://asciinema.org/a/hUwpV4pyhGK0k0nI68KzAO3pv) to use it as `spec.upstream`. It currently does not inject real payload URLs, and thus we cannot do a cluster upgrade with it. We may modify the returned graph and host it somewhere (see the example in this page) to achieve it.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| More examples can be found at [fauxinnati](https://fauxinnati-fauxinnati.apps.ota-stage.q2z4.p1.openshiftapps.com/). See [a demo](https://asciinema.org/a/hUwpV4pyhGK0k0nI68KzAO3pv) to use it as `cv.spec.upstream`. It currently does not inject real payload URLs, and thus we cannot do a cluster upgrade with it. We may modify the returned graph and host it somewhere (see the example in this page) to achieve it. | |
| More examples can be found at [fauxinnati](https://fauxinnati-fauxinnati.apps.ota-stage.q2z4.p1.openshiftapps.com/). See [a demo](https://asciinema.org/a/hUwpV4pyhGK0k0nI68KzAO3pv) to use it as `spec.upstream`. It currently does not inject real payload URLs, and thus we cannot do a cluster upgrade with it. We may modify the returned graph and host it somewhere (see the example in this page) to achieve it. |
🤖 Prompt for AI Agents
In `@docs/dev/feed-cvo-custom-graphs.md` at line 31, The documentation uses an
inconsistent field reference `cv.spec.upstream`; update the example text to
reference the correct Kubernetes resource field name (use `spec.upstream` or the
fully-qualified `clusterversion.spec.upstream`) so readers can find the right
field; replace `cv.spec.upstream` with `spec.upstream` (or
`clusterversion.spec.upstream`) in the sentence and ensure any surrounding
examples/comments use the same corrected symbol.
|
/retitle NO-JIRA: Mention the fauxinnati in the developer documentation |
openshift-ci
Bot
changed the title
openshift-ci-robot
added
the
jira/valid-reference
|
@hongkailiu: This pull request explicitly references no jira issue. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
Co-authored-by: David Hurta <hurtadavid@gmail.com>
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: DavidHurta, hongkailiu 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 |
|
The changes are about docs. The risk is low. /verified by @hongkailiu |
openshift-ci-robot
added
the
verified
|
@hongkailiu: This PR has been marked as verified by DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
@hongkailiu: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
3 participants
It is so cool and thus worth a paragraph in our docs for it.
Then it will be our responsibility to maintain the tool since it is public which should not increase any security risks because the tool is accessible by anyone already.
Summary by CodeRabbit