Fix typo develop api guides#11264
Conversation
|
|
📝 WalkthroughSummaryMinor grammar and phrasing corrections in two documentation files:
Impact: Text-only documentation improvements with no functional or configuration changes. Both modifications enhance readability and clarity for documentation users. Effort: Low - minimal changes affecting only 3 lines total across two documentation files. WalkthroughThis pull request contains two minor documentation updates to WSO2 API Manager guides. The first change revises a sentence in the role-based access control documentation describing scope strings for Key Managers settings access. The second change corrects phrasing in the distributed deployment guide by adding the article "the" for grammatical consistency. Both modifications are textual refinements with no impact on functionality, configuration, or instructional content. 🚥 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 |
![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
🧹 Nitpick comments (1)
en/docs/administer/role-based-access-control.md (1)
24-24: Consider minor grammar and style improvements.The instructional text has a few areas that could be refined:
- Capitalization: "If" should be lowercase since it follows a comma in "For example, If..."
- Gender-neutral language: Replace "he can assign" with "they can assign" for inclusive documentation.
- Consistency: Consider capitalizing "Key Managers settings" to match the table entry on line 37.
📝 Suggested refinements
-4. In the `Select Permissions` menu, select the `Custom scope assignments` option. And select the scopes that you want to assign for the newly created role. You can refer to the following table when assigning the scopes. For example, If the admin wants the newly created user to access the key managers settings in the admin portal he can assign `apim:keymanagers_manage`, `apim:tenantInfo`, and `apim:admin_settings`. +4. In the `Select Permissions` menu, select the `Custom scope assignments` option. And select the scopes that you want to assign for the newly created role. You can refer to the following table when assigning the scopes. For example, if the admin wants the newly created user to access the Key Managers settings in the admin portal they can assign `apim:keymanagers_manage`, `apim:tenantInfo`, and `apim:admin_settings`.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/docs/administer/role-based-access-control.md` at line 24, The sentence in the "Select Permissions" step needs minor grammar and style fixes: change "If" to lowercase "if", replace the gendered "he can assign" with gender-neutral "they can assign", and optionally capitalize "Key Managers settings" to "Key Managers settings" for consistency with the table; update the example line that lists the scopes (`apim:keymanagers_manage`, `apim:tenantInfo`, `apim:admin_settings`) accordingly so it reads, for example, "for example, if the admin wants the newly created user to access the Key Managers settings in the admin portal, they can assign `apim:keymanagers_manage`, `apim:tenantInfo`, and `apim:admin_settings`."
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@en/docs/install-and-setup/setup/distributed-deployment/configuring-apim-as-a-gateway.md`:
- Line 35: Change the phrasing "with regards to" in the sentence referencing the
Quick Start Guide to the grammatically correct "with regard to" (singular) or
reword the sentence for clarity (e.g., "Refer to the Quick Start Guide for
trying out API Control Plane with Kubernetes Gateway using APIM-APK Agent").
Locate the sentence containing "with regards to trying out API Control Plane
with Kubernetes Gateway using APIM-APK Agent" and replace it with the corrected
wording.
---
Nitpick comments:
In `@en/docs/administer/role-based-access-control.md`:
- Line 24: The sentence in the "Select Permissions" step needs minor grammar and
style fixes: change "If" to lowercase "if", replace the gendered "he can assign"
with gender-neutral "they can assign", and optionally capitalize "Key Managers
settings" to "Key Managers settings" for consistency with the table; update the
example line that lists the scopes (`apim:keymanagers_manage`,
`apim:tenantInfo`, `apim:admin_settings`) accordingly so it reads, for example,
"for example, if the admin wants the newly created user to access the Key
Managers settings in the admin portal, they can assign
`apim:keymanagers_manage`, `apim:tenantInfo`, and `apim:admin_settings`."
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 2846f163-2d91-437d-9428-768e0a1a750b
📒 Files selected for processing (2)
en/docs/administer/role-based-access-control.mden/docs/install-and-setup/setup/distributed-deployment/configuring-apim-as-a-gateway.md
| ## Next Steps | ||
|
|
||
| You can refer the [Quick Start Guide](https://apk.docs.wso2.com/en/latest/get-started/quick-start-guide-with-cp/) with regards to trying out API Control Plane with Kubernetes Gateway using APIM-APK Agent. | ||
| You can refer to the [Quick Start Guide](https://apk.docs.wso2.com/en/latest/get-started/quick-start-guide-with-cp/) with regards to trying out API Control Plane with Kubernetes Gateway using APIM-APK Agent. |
There was a problem hiding this comment.
Fix grammar in “with regards to”.
Line 35 should use “with regard to” (singular) or be simplified for readability.
Suggested edit
-You can refer to the [Quick Start Guide](https://apk.docs.wso2.com/en/latest/get-started/quick-start-guide-with-cp/) with regards to trying out API Control Plane with Kubernetes Gateway using APIM-APK Agent.
+You can refer to the [Quick Start Guide](https://apk.docs.wso2.com/en/latest/get-started/quick-start-guide-with-cp/) to try out the API Control Plane with Kubernetes Gateway using APIM-APK Agent.As per coding guidelines: "Provide concise, actionable feedback focused on correctness and best practices. Avoid unnecessary detail or speculation."
📝 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.
| You can refer to the [Quick Start Guide](https://apk.docs.wso2.com/en/latest/get-started/quick-start-guide-with-cp/) with regards to trying out API Control Plane with Kubernetes Gateway using APIM-APK Agent. | |
| You can refer to the [Quick Start Guide](https://apk.docs.wso2.com/en/latest/get-started/quick-start-guide-with-cp/) to try out the API Control Plane with Kubernetes Gateway using APIM-APK Agent. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In
`@en/docs/install-and-setup/setup/distributed-deployment/configuring-apim-as-a-gateway.md`
at line 35, Change the phrasing "with regards to" in the sentence referencing
the Quick Start Guide to the grammatically correct "with regard to" (singular)
or reword the sentence for clarity (e.g., "Refer to the Quick Start Guide for
trying out API Control Plane with Kubernetes Gateway using APIM-APK Agent").
Locate the sentence containing "with regards to trying out API Control Plane
with Kubernetes Gateway using APIM-APK Agent" and replace it with the corrected
wording.
2 participants
Purpose
Goals
Approach
User stories
Release note
Documentation
Training
Certification
Marketing
Security checks
Followed secure coding standards: N/A (documentation-only change)
Ran FindSecurityBugs plugin and verified report: N/A
Confirmed no keys, passwords, tokens, usernames, or other secrets committed: yes
Samples
Related PRs
Migrations (if applicable)
Test environment
Learning