docs(STONEINTG-1717): update nudging docs for NudgeConfig CRD - #640
Open
kasemAlem wants to merge 1 commit into
Open
docs(STONEINTG-1717): update nudging docs for NudgeConfig CRD#640kasemAlem wants to merge 1 commit into
kasemAlem wants to merge 1 commit into
Conversation
Rewrote CLI section in component-nudges.adoc to use NudgeConfig CRD instead of kubectl patch spec.build-nudges-ref Added validation rules section documenting webhook constraints Added editing/removing relationships instructions Marked build-nudges-ref and build-nudged-by as deprecated in application-api.adoc; added full NudgeConfig v1beta2 API reference Updated building-olm.adoc nudge step to not be UI-specific Signed-off-by: Kasem Alem <kalem@redhat.com>
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
PR Summary by QodoUpdate nudging docs to use NudgeConfig CRD (v1beta2)
AI Description
Diagram
High-Level Assessment
Files changed (3)
|
|
🚀 Preview is available at: https://pr-640--konflux-docs.netlify.app |
Code Review by Qodo
1. Broken NudgeConfigList xref
|
![qodo-app-for-konflux-ci[bot]](https://avatars.githubusercontent.com/u/155583288?s=60&v=4){kind=small}
Comment on lines
+882
to
+885
| .Appears In: | ||
| **** | ||
| - xref:{anchor_prefix}-appstudio-redhat-com-v1beta2-nudgeconfiglist[$$NudgeConfigList$$] | ||
| **** |
There was a problem hiding this comment.
1. Broken nudgeconfiglist xref 🐞 Bug ≡ Correctness
The new NudgeConfig section links to NudgeConfigList, but no NudgeConfigList anchor/section exists in application-api.adoc, producing an unresolved xref (and potentially a docs build warning/error). Readers also can’t navigate to the referenced type.
Agent Prompt
## Issue description
`application-api.adoc` includes an xref to `NudgeConfigList` in the NudgeConfig “Appears In” block, but the document does not define a `NudgeConfigList` section/anchor. This causes an unresolved xref.
## Issue Context
The v1beta2 (NudgeConfig) section is manually inserted and currently defines `NudgeConfig`, `NudgeConfigSpec`, `NudgeRelationship`, `NudgeModeType`, and `NudgeConfigStatus`, but not the corresponding List type.
## Fix Focus Areas
- modules/reference/pages/kube-apis/application-api.adoc[872-915]
- modules/reference/pages/kube-apis/application-api.adoc[882-885]
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
| @@ -1,11 +1,13 @@ | |||
| // Generated documentation. Please do not edit. | |||
| // NOTE: The appstudio.redhat.com/v1beta2 section (NudgeConfig) below is manually maintained. | |||
There was a problem hiding this comment.
2. Generated docs edited manually 🐞 Bug ⚙ Maintainability
application-api.adoc is generated by hack/gen-api-docs.sh via crd-ref-docs, so the newly added “manually maintained” v1beta2 NudgeConfig content will be overwritten the next time API docs are regenerated.
Agent Prompt
## Issue description
A generated output file (`modules/reference/pages/kube-apis/application-api.adoc`) is being edited directly. The repo’s generation script rewrites this file, so the manual v1beta2/NudgeConfig section is not durable.
## Issue Context
`hack/gen-api-docs.sh` runs `crd-ref-docs` with `--output-path modules/reference/pages/kube-apis/application-api.adoc`. The `api-gen/templates/gv_list.tpl` template emits the file header and full rendered content, so a regen replaces the entire file.
## Fix Focus Areas
- modules/reference/pages/kube-apis/application-api.adoc[1-3]
- hack/gen-api-docs.sh[34-38]
- hack/gen-api-docs.sh[46-53]
- api-gen/templates/gv_list.tpl[4-17]
## Suggested direction
Move the manual v1beta2 section into a dedicated snippet file (for example under `modules/reference/pages/kube-apis/`), and update the generation pipeline (script or template) to append/include that snippet after generating `application-api.adoc` so regeneration preserves it.
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rewrote CLI section in component-nudges.adoc to use NudgeConfig CRD
instead of kubectl patch spec.build-nudges-ref
Added validation rules section documenting webhook constraints Added editing/removing relationships instructions
Marked build-nudges-ref and build-nudged-by as deprecated in
application-api.adoc; added full NudgeConfig v1beta2 API reference
Updated building-olm.adoc nudge step to not be UI-specific
more info in STONEINTG-1717
Assisted-By: Claude code 4.6