Conversation
Signed-off-by: Amro Misbah <amromisba7@gmail.com>
Signed-off-by: Amro Misbah <amromisba7@gmail.com>
📝 WalkthroughWalkthroughDocumentation updates to the OpenBanking installation guide replace Changes
Sequence Diagram(s)Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
mo-auto
added
the
area-documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/openbanking/install-cn.md`:
- Around line 46-48: There are markdownlint violations: change the fenced code
blocks to the repository's preferred fence style and remove trailing spaces in
the affected blocks; specifically, replace or normalize the shown bash fence
(the kubectl snippet using ```bash) and the other newly added code blocks to
match the repo's configured fence character (backticks vs tildes) and language
tag usage, and delete any trailing whitespace on the lines flagged (including
the single-line trailing space in the block around the kubectl snippet and the
other mentioned blocks). Locate the fenced blocks containing the kubectl create
secret example and the surrounding newly added sections (the other listed code
blocks) and update their fences to match existing files and strip trailing
spaces from all lines in those blocks.
- Line 40: Fix the typos in the sentence mentioning installation prerequisites:
change "prerequistes" to "prerequisites" and "choosed" to "chosen" in the line
that references following the [docs] and edits to `openbanking-values.yaml`
based on the Gluu persistence choice; ensure the corrected sentence reads
smoothly and preserves links to ../install/helm-install/README.md and the
filename `openbanking-values.yaml`.
- Line 222: The TOKEN assignment uses a curl invocation where the scope argument
contains Markdown link syntax, causing invalid shell input; edit the TOKEN line
(the curl command that sets TOKEN) to pass a plain scope string instead of
`[text](url)`—for example replace the markdown with the raw scope URL
(URL-encode characters if necessary) so the --data
"grant_type=client_credentials&scope=your_raw_scope_url" is sent correctly and
token retrieval succeeds.
Signed-off-by: Amro Misbah <amromisba7@gmail.com>
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/openbanking/install-cn.md (2)
77-83:⚠️ Potential issue | 🟠 MajorCorrect invalid YAML in the
globalsnippet.Line 78 is missing a colon (
global:). The current example is not valid YAML and will fail to parse, misleading users configuringopenbanking-values.yaml.Proposed fix
- global + global: auth-server: ingress: authServerProtectedToken: true authServerProtectedRegister: true🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/openbanking/install-cn.md` around lines 77 - 83, Fix the invalid YAML in the code block by adding the missing colon to the top-level mapping key "global" so the snippet becomes a valid mapping (i.e., change "global" to "global:"), ensuring the following nested keys like "auth-server" and its "ingress" children remain properly indented; update the code block in the install-cn.md snippet that contains the "global"/"auth-server"/"ingress" example accordingly.
261-273:⚠️ Potential issue | 🟠 MajorFix malformed YAML indentation in the
persistence.volumes/volumeMountsexample.The snippet mixes tab indentation (lines 263-270) with space indentation (lines 271-272), making it invalid YAML. The
mountPathandsubPathkeys are misaligned and inconsistently indented relative to their parent- name: custom-scopeskey.Proposed fix
```yaml persistence: - volumes: - - name: custom-scopes - configMap: - name: custom-scopes - volumeMounts: - - name: custom-scopes - mountPath: "/app/templates/scopes.ob.ldif" - subPath: scopes.ob.ldif + volumes: + - name: custom-scopes + configMap: + name: custom-scopes + volumeMounts: + - name: custom-scopes + mountPath: "/app/templates/scopes.ob.ldif" + subPath: scopes.ob.ldif</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@docs/openbanking/install-cn.mdaround lines 261 - 273, Fix the malformed
YAML indentation in the example by normalizing spacing and aligning keys under
the same parent: for the persistence block (persistence.volumes and
persistence.volumeMounts) ensure "volumes:" and "volumeMounts:" are indented
equally under persistence, the list item "- name: custom-scopes" is two spaces
deeper, and its children "configMap: name: custom-scopes" and for the
volumeMounts the keys "mountPath" and "subPath" are aligned beneath "- name:
custom-scopes"; update the snippet so keys are consistently spaced (no mixed
tabs) and nested like persistence -> volumes -> - name -> configMap -> name and
persistence -> volumeMounts -> - name -> mountPath/subPath.</details> </blockquote></details> </blockquote></details>♻️ Duplicate comments (2)
docs/openbanking/install-cn.md (2)
40-40:⚠️ Potential issue | 🟡 MinorFix remaining typo in installation prerequisite sentence.
Line 40 still uses “choosed”; this should be “chosen” for clarity in user-facing docs.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/openbanking/install-cn.md` at line 40, The sentence in docs referencing installation prerequisites contains a typo: replace the incorrect word "choosed" with the correct word "chosen" in the sentence that mentions openbanking-values.yaml so the line reads "...based on the Gluu persistence chosen." Update the document string accordingly (search for the phrase "openbanking-values.yaml" to locate the sentence).
46-48:⚠️ Potential issue | 🟡 MinorResolve remaining markdownlint warnings in newly added blocks.
Static analysis still reports MD046 (code block style) and MD009 (trailing spaces at Line 227) in these changed ranges.
Also applies to: 52-61, 214-217, 221-225, 227-227, 229-235, 239-242
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/openbanking/install-cn.md` around lines 46 - 48, The markdown has linter warnings MD046 (inconsistent code fence style) and MD009 (trailing spaces); update the affected blocks (e.g., the kubectl registry secret block containing the kubectl create secret docker-registry command and other blocks in the ranges noted) to use a consistent fenced code block style (triple backticks, include optional language token if appropriate) throughout the file and remove any trailing whitespace (notably at the reported Line 227 and similar lines). Ensure all code fences match the chosen style and trim end-of-line spaces for the listed ranges (52-61, 214-217, 221-225, 227, 229-235, 239-242).🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed. Outside diff comments: In `@docs/openbanking/install-cn.md`: - Around line 77-83: Fix the invalid YAML in the code block by adding the missing colon to the top-level mapping key "global" so the snippet becomes a valid mapping (i.e., change "global" to "global:"), ensuring the following nested keys like "auth-server" and its "ingress" children remain properly indented; update the code block in the install-cn.md snippet that contains the "global"/"auth-server"/"ingress" example accordingly. - Around line 261-273: Fix the malformed YAML indentation in the example by normalizing spacing and aligning keys under the same parent: for the persistence block (persistence.volumes and persistence.volumeMounts) ensure "volumes:" and "volumeMounts:" are indented equally under persistence, the list item "- name: custom-scopes" is two spaces deeper, and its children "configMap: name: custom-scopes" and for the volumeMounts the keys "mountPath" and "subPath" are aligned beneath "- name: custom-scopes"; update the snippet so keys are consistently spaced (no mixed tabs) and nested like persistence -> volumes -> - name -> configMap -> name and persistence -> volumeMounts -> - name -> mountPath/subPath. --- Duplicate comments: In `@docs/openbanking/install-cn.md`: - Line 40: The sentence in docs referencing installation prerequisites contains a typo: replace the incorrect word "choosed" with the correct word "chosen" in the sentence that mentions openbanking-values.yaml so the line reads "...based on the Gluu persistence chosen." Update the document string accordingly (search for the phrase "openbanking-values.yaml" to locate the sentence). - Around line 46-48: The markdown has linter warnings MD046 (inconsistent code fence style) and MD009 (trailing spaces); update the affected blocks (e.g., the kubectl registry secret block containing the kubectl create secret docker-registry command and other blocks in the ranges noted) to use a consistent fenced code block style (triple backticks, include optional language token if appropriate) throughout the file and remove any trailing whitespace (notably at the reported Line 227 and similar lines). Ensure all code fences match the chosen style and trim end-of-line spaces for the listed ranges (52-61, 214-217, 221-225, 227, 229-235, 239-242).
3 participants
closes #2682
Summary by CodeRabbit