Fix grammar issue in API Manager documentation#11262
Fix grammar issue in API Manager documentation#11262Arshvinth wants to merge 1 commit intowso2:masterfrom
Conversation
|
|
📝 WalkthroughChangesFixed a grammar issue in the role-based access control documentation by adding the missing word "to" in Step 3, item 4 of the Admin Portal guide. This improves the clarity of the sentence instructing users how to refer to the scopes table when assigning custom scope mappings. File modified:
Impact: Minimal documentation correction with no functional impact. WalkthroughThis pull request updates documentation in the role-based access control administration guide. Specifically, it modifies the instructional text in Step 3 (Assign scopes), item 4, to refine the wording in the sentence that directs users to reference the scopes table when setting up custom scope mappings. The change is limited to text refinement with no alterations to example scope values, procedural steps, or the overall flow of the instructions. 🚥 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)
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.
🧹 Nitpick comments (1)
en/docs/administer/role-based-access-control.md (1)
24-24: Grammar fix is correct.The addition of "to" in "refer to the following table" improves the grammar. The change is appropriate.
While the line is being updated, consider these optional refinements to the same sentence:
- Replace "And select the scopes" with "Select the scopes" (starting a sentence with "And" is informal in technical documentation)
- Change "If the admin" to "if the admin" (lowercase since it's mid-sentence)
- Add a comma: "admin portal, he can assign" for better readability
📝 Optional refinement for consistency
-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. 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`.🤖 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, Update the sentence in the "Select Permissions" menu step to improve formality and punctuation: remove the leading "And" so it reads "Select the scopes that you want to assign for the newly created role," lowercase "If" to "if" in the example clause, and add a comma after "admin portal" so the example becomes "...in the admin portal, he can assign `apim:keymanagers_manage`, `apim:tenantInfo`, and `apim:admin_settings`." Ensure the change is applied to the sentence containing "Select Permissions" and the example scope list.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@en/docs/administer/role-based-access-control.md`:
- Line 24: Update the sentence in the "Select Permissions" menu step to improve
formality and punctuation: remove the leading "And" so it reads "Select the
scopes that you want to assign for the newly created role," lowercase "If" to
"if" in the example clause, and add a comma after "admin portal" so the example
becomes "...in the admin portal, he can assign `apim:keymanagers_manage`,
`apim:tenantInfo`, and `apim:admin_settings`." Ensure the change is applied to
the sentence containing "Select Permissions" and the example scope list.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 2c93b23a-d4fe-4703-9fea-d191e8ac3bc3
📒 Files selected for processing (1)
en/docs/administer/role-based-access-control.md
2 participants
Purpose
Goals
Approach
User stories
Release note
Documentation
Training
Certification
Marketing
Samples
Related PRs
Migrations (if applicable)
Test environment
Learning