Update the notifications config article #7557#2026
Update the notifications config article #7557#2026alhambrav wants to merge 8 commits intocraftercms:masterfrom
Conversation
sumerjabri
left a comment
sumerjabri
left a comment
There was a problem hiding this comment.
Is this for v5.0.0? If so, we need to update the file to be last updated v5 and make this a draft PR.
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughUpdates Studio documentation: bumps version to 5.0.0, replaces Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 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. Review rate limit: 0/1 reviews remaining, refill in 24 minutes and 36 seconds.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: 5
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
source/reference/modules/studio.rst (2)
2961-2973: Fix path in caption (same inconsistency as above)Use workflow/notification-config.xml to match the default property and actual location.
- :caption: *CRAFTER_HOME/data/repos/sites/SITENAME/sandbox/config/studio/notification-config.xml* + :caption: *CRAFTER_HOME/data/repos/sites/SITENAME/sandbox/config/studio/workflow/notification-config.xml*
2984-3019: Fix path in caption (same inconsistency as above)Align caption path with workflow/notification-config.xml.
- :caption: *CRAFTER_HOME/data/repos/sites/SITENAME/sandbox/config/studio/notification-config.xml* + :caption: *CRAFTER_HOME/data/repos/sites/SITENAME/sandbox/config/studio/workflow/notification-config.xml*
🧹 Nitpick comments (3)
source/reference/modules/studio.rst (3)
3077-3080: Verify variable naming/source consistency (reviewer/submitter fields)This template mixes snake_case (first_name, last_name) and camelCase (elsewhere you use approver.firstName). If the backing model uses consistent keys, this will break.
Please confirm the actual variables passed to FTL in Studio 5.x and standardize (all camelCase or whatever Studio emits). Based on learnings
3097-3108: Good: schedule/target/reviewer comment surfaced; add variables to docsYou reference publishPackage.* fields not listed in “Template Variables.” Document these (packageType, schedule, target, reviewerComment, submitterComment, etc.) and new file.* fields (page, browserUri, action, path, packageId, liveError, stagingError).
3178-3216: Template variable consistency (reviewer. fields) and links look fine otherwise*After fixing “&&”, please also verify reviewer.first_name/last_name names as above.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/reference/modules/studio.rst(12 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-09-02T20:40:32.613Z
Learnt from: alhambrav
PR: craftercms/docs#2042
File: source/reference/modules/studio.rst:0-0
Timestamp: 2025-09-02T20:40:32.613Z
Learning: When reviewing CrafterCMS Studio documentation, property names in configuration examples should match the actual Studio source code implementation, even if the underlying Git config keys are different. Studio may have a translation layer that maps Studio property names to actual Git configuration keys.
Applied to files:
source/reference/modules/studio.rst
🔇 Additional comments (8)
source/reference/modules/studio.rst (8)
2-2: Meta update looks goodUpdated last-updated to 5.0.0 is consistent with the new content.
100-102: Good addition to the config properties indexNew “Notification Service Configuration” entry improves discoverability.
105-105: Description reads wellWording aligns with the section content below.
3023-3030: Nice use of collapsible detailsThe expandable block improves readability.
3051-3052: LGTM: clearer itemization of deployment failuresThe extra details per file are helpful.
3067-3067: Subject logic: good conditional for scheduled vs approvedLooks correct.
3086-3095: Inline link around pages is correctConditional anchor wrapping by file.page is solid.
3267-3314: Great addition: Notification Service Configuration defaultsSection is clear and useful. Ensure the configuration file path here matches all captions above (workflow/notification-config.xml) to avoid user confusion.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
source/reference/modules/studio.rst (1)
3090-3093: Clarify timezone precedence between templates and global config.You document
studio.notification.timezone(UTC default), but examples also set<#setting time_zone='EST'>in-template. Add one note clarifying template-level timezone overrides the global property for that template.Also applies to: 3312-3331
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@source/reference/modules/studio.rst` around lines 3090 - 3093, Add a short clarifying note stating that the template-level tag <#setting time_zone='...'> takes precedence over the global property studio.notification.timezone (which defaults to UTC) for that specific template; update the text near the example around the <#setting time_zone='EST'> snippet and repeat the same clarification in the other section covering lines 3312–3331 so both places explicitly state that template settings override the global timezone for that template only.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@source/reference/modules/studio.rst`:
- Around line 3045-3046: The intro sentence "Below is an example of a configured
email messages for each point in the workflow, found in between the tag
``<emailTemplates>`` in the notifications configuration file." is awkward;
update it to a cleaner phrasing such as: "Below is an example of configured
email messages for each point in the workflow, found between the
``<emailTemplates>`` tag in the notifications configuration file." Replace the
existing sentence in the Configure Templates section to use this corrected
wording and keep the reference to the ``<emailTemplates>`` tag.
---
Nitpick comments:
In `@source/reference/modules/studio.rst`:
- Around line 3090-3093: Add a short clarifying note stating that the
template-level tag <#setting time_zone='...'> takes precedence over the global
property studio.notification.timezone (which defaults to UTC) for that specific
template; update the text near the example around the <#setting time_zone='EST'>
snippet and repeat the same clarification in the other section covering lines
3312–3331 so both places explicitly state that template settings override the
global timezone for that template only.
🪄 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: 38a63193-261b-4490-b780-f302f9f6a3f6
📒 Files selected for processing (1)
source/reference/modules/studio.rst
2 participants
Ticket reference or full description of what's in the PR
Update the notifications config article craftercms/craftercms#7557