Instructions to restart devices for member and enable/disable unlimited retention for admins #374
Conversation
WalkthroughAdded a new "Other Settings" organization documentation page and navigation link; expanded device management docs with detailed retain/cancel instructions and a new "Restart private device" subsection (including images and alt text changes); updated ADMIN role description and added the Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant User
participant Browser
participant UI as "Manage Devices UI"
participant Auth as "Permission Check"
participant DeviceSvc as "Device Service"
User->>Browser: Open Manage Devices page
Browser->>UI: Render device entries (private/public) with actions
User->>UI: Click "Restart" on a private device
UI->>Auth: Verify org_setting.reboot_private_device for user
alt Permission granted
Auth-->>UI: allowed
UI->>DeviceSvc: Send immediate restart command
DeviceSvc-->>UI: ack
UI-->>User: Show restart started notice
else Permission denied
Auth-->>UI: denied
UI-->>User: Hide restart option / show permission note
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
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 |
tungmhoang
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (12)
docs/modules/organization/nav.adoc (1)
41-42: Consider moving the new entry under a more intuitive sectionPlacing Other settings immediately after SSO Authentication may mislead readers; the page covers org-wide configuration, not authentication. A more discoverable spot is right after Roles or grouped in a dedicated Settings subsection (similar to Teams, Roles, Users).
Re-ordering in the nav file is trivial and improves IA.docs/modules/organization/pages/roles/user-roles-and-permissions.adoc (2)
16-17: Tighten wording for the ADMIN role“… permissions to manage all devices in the organization in the settings.” is awkward.
Recommended:-The ADMIN role must be assigned by the Organization Owner or another ADMIN. ADMINs are given xref:_permissions[all user permissions] and permissions to manage all devices in the organization in the settings. +The ADMIN role must be assigned by the Organization Owner or another ADMIN. ADMINs have xref:_permissions[all user permissions] **plus** full device-management privileges available in **Organization Settings**.
93-97: Anchor clashes & long link text
[#_org_setting_reboot_private_device]duplicates the anchor-style used elsewhere; verify no existing ID collision.- Link text manage device is generic; readers won’t know it jumps to the restart section.
Suggest concise descriptive text:-…[manage device,window=read-later] +…[Restart private device page,window=read-later]docs/modules/devices/pages/manage-devices.adoc (3)
54-56: Clarify “Unlimited” retention noteCurrent sentence is wordy. Suggest:
-Organization admins can enable or disable xref:organization:other-settings.adoc#_device_retention[the Unlimited option,window=read-later] when retaining a device. +Organization admins can enable or disable the xref:organization:other-settings.adoc#_device_retention[Unlimited retention option,window=read-later].
60-61: Remove stray space before comma-To restart a private device , select *Restart*. +To restart a private device, select *Restart*.
71-76: Permission bullet: add article & code formattingMinor language polish:
-* Request the administrator to assign a role with the xref:organization:roles/user-roles-and-permissions.adoc#_org_setting_reboot_private_device[reboot private device,window=read-later] permission to your account. +* Ask an administrator to assign you a role that includes the xref:organization:roles/user-roles-and-permissions.adoc#_org_setting_reboot_private_device[`org_setting.reboot_private_device`,window=read-later] permission.docs/modules/organization/pages/other-settings.adoc (6)
16-24: Use parallel verb forms in bulletsMaintain consistent “Enable or disable …” pattern:
-* _Capture the video in a manual session_: Enable/disable video capturing for manual sessions. -* _Capture the screenshot in a manual session_: Enable/disable screenshot capturing for manual sessions. +* _Capture the video in a manual session_: Enable or disable video capture for manual sessions. +* _Capture the screenshot in a manual session_: Enable or disable screenshot capture for manual sessions.
25-30: Title-case heading and polish bullet copy-=== XML tree in Manual session +=== XML tree in manual session-* _Show only important layers in XML tree_: Enable/disable the display of layers that are marked as important for accessibility in Manual sessions on Android devices. -* _Show Android's Navigation bar and Status bar layer_: Enable/disable displaying of the Navigation bar and Status bar layer in Manual sessions on Android devices. +* _Show only important layers in XML tree_: Enable or disable displaying only accessibility-important layers in manual sessions on Android devices. +* _Show Android navigation and status bar layers_: Enable or disable showing the navigation and status bar layers in manual sessions on Android devices.
35-42: Grammar fix – plural “customers”-For Hybrid and Standalone/On-Prem customer, deviceShare must be … +For Hybrid and Standalone/On-Prem customers, deviceShare must be …
46-50: Remove superfluous wording-Select the default access rights for new apps uploaded to the Kobiton App Repo with either of the below: +Choose the default access level for new apps uploaded to the Kobiton App Repo:
55-56: Clarify description of unlimited retention toggleConsider explicitly stating its effect:
-* _Allow unlimited retention_: Whether to allow unlimited device retention for the whole organization. +* _Allow unlimited retention_: Lets users retain devices indefinitely instead of a fixed duration.
59-64: Capitalisation consistency-* _Show "Public Devices" Tab in Device List page_: Whether to display the Public Devices tab in the devices list. +* _Show “Public Devices” tab in Device List page_: Show or hide the **Public Devices** tab on the Devices page.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
docs/modules/devices/images/device-modal-restart.pngis excluded by!**/*.pngdocs/modules/organization/images/other-settings.pngis excluded by!**/*.png
📒 Files selected for processing (4)
docs/modules/devices/pages/manage-devices.adoc(1 hunks)docs/modules/organization/nav.adoc(1 hunks)docs/modules/organization/pages/other-settings.adoc(1 hunks)docs/modules/organization/pages/roles/user-roles-and-permissions.adoc(2 hunks)
🧰 Additional context used
🧠 Learnings (1)
docs/modules/organization/pages/other-settings.adoc (1)
Learnt from: tungmhoang
PR: kobiton/docs#277
File: docs/modules/automation-testing/pages/get-a-session-id/using-the-kobiton-portal.adoc:16-16
Timestamp: 2025-06-05T04:25:21.053Z
Learning: In Kobiton documentation, "Session Overview" terminology is still appropriate when referring to the overview section/view within Session Explorer, even when other parts of the documentation use "Session Explorer" terminology.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Test Build
- GitHub Check: publish-docs-test
docs/modules/organization/pages/roles/user-roles-and-permissions.adoc
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
docs/modules/organization/pages/other-settings.adoc (5)
18-21: Streamline phrasing & align bullet titles with action.The current wording is a bit clunky (“Capture the video …”, “Capture the screenshot …”) and mixes singular/plural. Tightening the language improves readability and follows the imperative-verb pattern used elsewhere.
-* _Capture the video in a manual session_: Enable/disable video capturing for manual sessions. The captured video can be accessed from the Session Overview. -* _Capture the screenshot in a manual session_: Enable/disable screenshot capturing for manual sessions. +* _Capture video in manual sessions_: Enable or disable video recording for manual sessions. The captured video is available in Session Overview. +* _Capture screenshots in manual sessions_: Enable or disable screenshot capture for manual sessions.
23-24: Fix “precedent” → “precedence” & drop passive filler.“Take precedent” is incorrect; the idiom is “take precedence”. This quick tweak also removes an extra “will” and clarifies the subject.
-The settings above will take precedent over all configurations related to video and screenshot capture in the `dc.ini` file of the Mac mini host. +These settings take precedence over any video or screenshot-capture configuration in the `dc.ini` file on the Mac mini host.
27-30: Clarify navigation-bar bullet & fix capitalization.Small wording clean-ups make the option name/action clearer and use sentence-case “manual sessions” for consistency.
-* _Show Android's Navigation bar and Status bar layer_: Enable/disable displaying of the Navigation bar and Status bar layer in Manual sessions on Android devices. +* _Show Android navigation and status-bar layers_: Enable or disable display of the Navigation and Status bar layers in manual sessions on Android devices.
46-50: Tighten instruction sentence.The lead-in sentence is verbose and slightly awkward. This rewrite is shorter and keeps focus on the user action.
-Select the default access rights for new apps uploaded to the Kobiton App Repo with either of the below: +Choose the default access level for newly uploaded apps in the Kobiton App Repo:
61-62: Lower-case “public devices” & use direct language.Capitalizing “Public” is unnecessary, and “Ensure” is clearer than “Make sure”.
-Make sure your organization is not using Public devices before disabling this setting. +Ensure that your organization is not using any public devices before disabling this setting.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/modules/devices/pages/manage-devices.adoc(2 hunks)docs/modules/organization/pages/other-settings.adoc(1 hunks)docs/modules/organization/pages/roles/user-roles-and-permissions.adoc(2 hunks)
🧠 Learnings (1)
docs/modules/organization/pages/other-settings.adoc (1)
Learnt from: tungmhoang
PR: #277
File: docs/modules/automation-testing/pages/get-a-session-id/using-the-kobiton-portal.adoc:16-16
Timestamp: 2025-06-05T04:25:21.053Z
Learning: In Kobiton documentation, "Session Overview" terminology is still appropriate when referring to the overview section/view within Session Explorer, even when other parts of the documentation use "Session Explorer" terminology.
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/modules/organization/pages/roles/user-roles-and-permissions.adoc
- docs/modules/devices/pages/manage-devices.adoc
🧰 Additional context used
🧠 Learnings (1)
docs/modules/organization/pages/other-settings.adoc (1)
Learnt from: tungmhoang
PR: #277
File: docs/modules/automation-testing/pages/get-a-session-id/using-the-kobiton-portal.adoc:16-16
Timestamp: 2025-06-05T04:25:21.053Z
Learning: In Kobiton documentation, "Session Overview" terminology is still appropriate when referring to the overview section/view within Session Explorer, even when other parts of the documentation use "Session Explorer" terminology.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Test Build
- GitHub Check: publish-docs-test
erincbailey
left a comment
erincbailey
left a comment
There was a problem hiding this comment.
Please see my comments
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
docs/modules/devices/images/device-modal-retained.pngis excluded by!**/*.png
📒 Files selected for processing (3)
docs/modules/devices/pages/manage-devices.adoc(2 hunks)docs/modules/organization/pages/other-settings.adoc(1 hunks)docs/modules/organization/pages/roles/user-roles-and-permissions.adoc(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/modules/organization/pages/other-settings.adoc
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Test Build
- GitHub Check: publish-docs-test
🔇 Additional comments (6)
docs/modules/organization/pages/roles/user-roles-and-permissions.adoc (2)
16-16: Updated ADMIN role description is clear and contextually relevant.The addition of "permissions to manage all devices in the organization in the settings" properly sets the context for the device management permission that follows.
89-97: Permissions are properly documented with correct anchors and cross-references.The soft_book permission description is now more explicit about what "retention" means, and the new org_setting.reboot_private_device permission is clearly documented with proper anchors that link correctly from the manage-devices.adoc file.
Verify that the cross-reference from manage-devices.adoc correctly points to the new permission anchor
#_org_setting_reboot_private_deviceon line 94, and that all related links function as expected.docs/modules/devices/pages/manage-devices.adoc (4)
15-15: Image width updates are appropriate and consistent.The width adjustments follow the existing patterns in the file and improve context display for device management actions.
Also applies to: 23-23, 50-50
52-57: Retain device section now provides comprehensive guidance.The expanded instructions clearly explain how to reserve a device, what durations are available, what users will see displayed, and important cleanup policy behavior. This addresses the previous feedback requesting more detailed retain documentation.
59-66: Cancel retain subsection is well-structured with proper permission reference.The new section clearly explains how to release retained devices and correctly references the cancel retain permission with an anchor link to the permission definition.
68-86: Restart private device section is comprehensive with proper permissions and safety warnings.The new section clearly documents the restart feature with appropriate permission checks, device type limitations, and an important safety warning about immediate restart. All cross-references are properly anchored.
|
@erincbailey ready for your review again. |
Summary
Related PRs, issues, or features (optional)
Metadata
PR contributor checklist
My PR follows the Kobiton Docs contributor guidelines, meaning:
nav.adocfile.en-us) from my URLs.Summary by CodeRabbit