Add maintenance mode

[alhambrav]

Ticket reference or full description of what's in the PR

Add maintenance mode craftercms/craftercms#5652

[coderabbitai]

Summary by CodeRabbit

• Documentation
  • Added comprehensive Maintenance Mode docs with configuration guidance, behavior descriptions, visual references, and links to system settings (enterprise feature).
  • Added system-scope permissions documentation for managing and reading system properties and for API access during maintenance mode.
  • Expanded Settings Tool reference with additional configuration options, preview token guidance, and management workflows.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Walkthrough

The PR updates documentation across three files to reflect version 4.5.0 changes, adding new sections on Maintenance Mode, system-scope permissions (system_properties_manage, system_properties_read, allowed_in_maintenance), and expanded Settings Tool / Global Config documentation with related UI flows and visual assets.

Changes

Cohort / File(s)	Summary
Author Documentation & Maintenance Mode source/by-role/author/index.rst	Updated last-updated to 4.5.0. Added a new "Maintenance Mode" section (enterpriseOnly, Since 4.5.0) with descriptive text, three illustrative images, and a link to system settings. The block was inserted twice, creating duplicated content.
System-Scope Permissions source/includes/available-permissions-system-scope.rst	Added three system-scope permissions: system_properties_manage (update/write/delete system properties), system_properties_read (read system properties), and allowed_in_maintenance (permit system API access during maintenance mode). Entries include usage notes and API endpoint references; marked enterpriseOnly.
Studio Reference & Settings Tool source/reference/modules/studio.rst	Bumped last-updated to 4.5.0. Inserted multiple new documentation blocks under Global Config and Settings Tool (including Maintenance Mode UI flows, Preview Token management, images, and code examples). Added visual separators; content repeats in multiple nearby sections.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Add maintenance mode' directly matches the main change described in the PR objectives and raw summary.
Description check	✅ Passed	The description includes a ticket reference (GitHub issue #5652) and briefly describes the feature being added, matching the template requirements.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d33f28b and b9743ad.

📒 Files selected for processing (1)

• source/reference/modules/studio.rst

🔇 Additional comments (2)

source/reference/modules/studio.rst (2)

1-3: Version metadata aligned with 4.5.0 content

:last-updated: 4.5.0 is appropriate given the new 4.5.0 features documented in this file; no changes needed.

---

6020-6068: New Settings / Maintenance Mode section looks correct and clear

The Settings tool and Maintenance Mode descriptions, version tag, enterprise-only marker, and behavior notes (including allowed_in_maintenance access) are all consistent with the surrounding documentation style and clearly explain the feature. Only follow-ups I’d consider:

• Ensure the author-maintenance-mode target exists so the cross-reference resolves.
• Optionally add a short note pointing readers to where allowed_in_maintenance is defined in the permissions tables, to make it easier to discover how to grant it.

Otherwise this section is good to go.

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

source/reference/modules/studio.rst (1)

5871-6062: Token Management & Maintenance Mode docs are solid; consider a couple of cross-links

The new Token Management (API/Preview token) and Settings/Maintenance Mode sections read clearly and are consistent with the rest of the page.

Two small, optional improvements to tighten things up:

• In the API Token and Preview Token subsections, consider adding a short sentence that points to the Access Tokens configuration section (anchor studio-access-tokens) so admins know where to tune issuer/audience/timeouts and related JWT settings.
• In Maintenance Mode, consider adding a brief note that access during maintenance is governed by the corresponding system-scope permission (documented under Permission Descriptions on this page), so readers know how to allow specific users/groups to keep working while maintenance mode is on.

These would improve discoverability without changing the behavior you’ve documented.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 307f0c1 and d33f28b.

📒 Files selected for processing (10)

• source/_static/images/content-author/maintenance-mode-on-fullscreen.webp
• source/_static/images/content-author/maintenance-mode-on-login.webp
• source/_static/images/content-author/maintenance-mode-on-while-working.webp
• source/_static/images/system-admin/main-menu/main-menu-cluster.webp
• source/_static/images/system-admin/main-menu/main-menu-settings.webp
• source/_static/images/system-admin/main-menu/maintenance-mode-on-confirmation.webp
• source/_static/images/system-admin/main-menu/maintenance-mode-on.webp
• source/by-role/author/index.rst
• source/includes/available-permissions-system-scope.rst
• source/reference/modules/studio.rst

🔇 Additional comments (3)

source/includes/available-permissions-system-scope.rst (1)

110-121: Clarify enterpriseOnly scope for system_properties_manage permission.

Line 115 applies the |enterpriseOnly| tag only to the "Set system maintenance mode status" API endpoint. This is ambiguous—it's unclear whether the entire system_properties_manage permission is enterprise-only or only the maintenance mode API is restricted. For clarity, either:

1. Move |enterpriseOnly| to the permission name (lines 110) to indicate the permission itself is enterprise-only, or
2. Keep it on line 115 if only the maintenance mode API is enterprise-restricted, but add a note explaining this caveat.

source/by-role/author/index.rst (1)

597-639: The :ref:System Settings `` anchor exists and all three image files (maintenance-mode-on-while-working.webp, `maintenance-mode-on-login.webp`, `maintenance-mode-on-fullscreen.webp`) are correctly located in the repository. No technical issues found with the references or image paths.

Likely an incorrect or invalid review comment.

source/reference/modules/studio.rst (1)

2-2: Version metadata aligns with new 4.5.0 content

Updating :last-updated: to 4.5.0 matches the newly added Settings |enterpriseOnly| section marked as “Since 4.5.0”, so this header change looks correct.