Re-write content on updating system workflow message templates after CiviCRM upgrades #53
Conversation
This content is from the User Guide here: https://github.com/seanmadsen/civicrm-user-guide/blame/f00ec1da8b315ea137c47a795958afc9f307e5e5/docs/email/message-templates.md#L121 No edits in this commit. Just a direct import.
| Within your installed CiviCRM files, navigate to `CRM/Upgrade` and look through the `*.msg_template` folders. Make sure to examine all versions between your previously-installed version and your currently-installed version. | ||
|
|
||
| !!! tip "For example" | ||
| By looking in the `4.7.23.msg_template` folder, we can see that the "Contribution invoice receipt" template was changed in version 4.7.23. So, if you are upgrading from a version prior to 4.7.23 to a version after 4.7.23, then you'll need to note this template as one which has changed. |
There was a problem hiding this comment.
@seanmadsen it should be noted that in general hopefully there should be a post upgrade message which mentions any template updates but may not be 100% always true ping @totten
There was a problem hiding this comment.
Yeah I thought about that too. I've seen those messages, but I wasn't sure whether it would be a good idea to rely on them for these instructions. They seem somewhat ephemeral to me. Like, if there could be a way to go back and view that message after you exit the upgrade screen then we could give those instructions to the user. But if we rely on them having already looked at that message and remembered its content then I think some people will be frustrated. Tim maybe you know of a way to bring up that message again?
There was a problem hiding this comment.
Also what would be really cool (and maybe this already is the case?) is if that post upgrade message would specifically call attention to templates which users have customized and CiviCRM has upgraded. I haven't taken the time to generate this message and see what it says, but if it does in fact get that specific, then it would be quite compelling to rely on it!
* Remove (and link to) duplicate content that was moved to the Sysadmin Guide in civicrm/civicrm-sysadmin-guide#53 * Add a screenshot * Clarify the dangers of making updates to these templates
|
Corresponding User Guide PR: civicrm/civicrm-user-guide#237 Please merge that one when merging this one |
|
I'm gonna go ahead and merge this since it's been a week. I'm happy to adjust this later on if others have more thoughts. |
Before
After
These changes should resolve #13 (pending a corresponding PR on the User Guide that I'll be creating soon)
Anyone want to review this? @michaelmcandrew @MegaphoneJon @seamuslee001 ?