update civicrm/donate perks documentation authored by Jérôme Charaoui's avatar Jérôme Charaoui
fix tpo/web/donate-neo#181

the documentation was imported from the Google Doc at
https://docs.google.com/document/d/1Z33h_zzN9HQFLKJf0QlRqwSQ-N1ucIYk7Lt9403tAFM/edit?tab=t.0
......@@ -25,6 +25,51 @@ accessed at: https://crm.torproject.org/user/login
# Howto
## Updating premiums
From time to time, typically around the annual year-end campaign (YEC), the donation gift/perks offered on https://donate.torproject.org need to be updated.
The first step is to update the data in CiviCRM.
### Create the perks
- Go to: [Contributions > Premiums (Thank-you Gifts](https://crm.torproject.org/civicrm/admin/contribute/managePremiums?reset=1)
- Edit each product as follows:
- **Name**: Name displayed for the premium
- **Description**: subtext under the title, ex: "Get this year’s Tor Onions T-shirt"
- **SKU**: SKU of the product, or if it’s a t-shirt with variants, the common part of the SKU for all sizes of the product (with no dash at the end)
- **Image**: A PNG image can be uploaded using the "upload from my computer" option
- **Minimum contribution amount**: minimum for non-recurring donations
- **Market value**: not used, can be "1.00"
- **Actual cost of Product**: not used, ignore
- **Financial Type**: not used, ignore
- **Options**: comma-delimited "SKU=label" for size selection and corresponding SKUs. For example: `T22-RCF-C01=Small,T22-RCF-C02=Medium,T22-RCF-C03=Large,T22-RCF-C04=XL,T22-RCF-C05=2XL,T22-RCF-C06=3XL,T22-RCF-C07=4XL` (NO SIZES? NO SKU - work this out with mathieu)
- **Enabled?**: checked (uncheck if the perk is not used anymore)
- **Subscription or Service Settings**: ignore, not used
- **Minimum Recurring Amount**: Enter the recurring donation amount that makes this premium available
- **Sort**: decimal number that helps sort the items on the list of perks (in ascending order, i.e. a lower order/weight is displayed first)
- **Image alt text**: alt text for the perk image html tag
**New perks**: disable the old perk instead of updating the SKU to avoid problems with older data.
### Associate with contributions
Perks must be associated with the CiviCRM "contribution page". TPA does not use these Contribution Pages directly, but that is where the settings are stored for donate-neo, such as the ThankYou message displayed on transaction receipts.
- Go to: [Contributions > Manage Contribution Pages](https://crm.torproject.org/civicrm/admin/contribute?reset=1)
- Find the "Your donation to the Tor Project" list item and on right right side, click the "configure" link
- On the contribution page settings form, click the "Premiums" tab
Here you can then associate the perks (premiums) created in the previous section with the page.
If the "add new" link is not displayed, it’s because all available premiums have already been added.
### Export the JSON data for donate-neo
When done, export the data in JSON format using this page: https://crm.torproject.org/civicrm/tpa-perks-json
The next steps are detailed [on the donate wiki page](service/donate#updating-perk-data).
## Monitoring mailings
The CiviCRM server can generate large mailings, in the order of
......
......