Update the notifications config article #7557 #2026
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.
Summary by CodeRabbit
WalkthroughReplaces references to Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ 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: 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.
2 participants
Ticket reference or full description of what's in the PR
Update the notifications config article craftercms/craftercms#7557