Add documentation that summarizes Solidus's built-in promotion calculators #2524
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gmacdougall
requested changes
Mar 1, 2018
| ### Flexi rate | ||
|
|
||
| The [`Spree::Calculator::FlexiRate` calculator][flexi-rate] provides a flexible | ||
| rate depending on the items on an order. (Or, a subset of specific line items on |
There was a problem hiding this comment.
The flexible rate needs more explanation here.
|
|
||
| - `base_percent`: The base discount for any order where the promotion applies. | ||
| - `tiers`: A hash where the key is the minimum order total for the tier and the | ||
| value is the tier discount: `{ tier=>discount_percentage }`. |
There was a problem hiding this comment.
It's difficult to infer what this needs to be based upon the table above.
kennyadsl
reviewed
Mar 10, 2018
| # Promotion calculators | ||
|
|
||
| Promotion calculators are similar to [shipping | ||
| calculators][shipping-calculators]: the calculate against your preferred |
There was a problem hiding this comment.
the calculate -> they calculate?
| ### Percent on line item | ||
|
|
||
| The [`Spree::Calculator::PercentOnLineItem` calculator][percent-on-line-item] | ||
| provide a percentage-based discount for each applicable line item in an order. |
|
|
||
| The [`Spree::Calculator::PercentOnLineItem` calculator][percent-on-line-item] | ||
| provide a percentage-based discount for each applicable line item in an order. | ||
| In the `solidus_backend` interface, this calculator is labeled "Percent Per |
There was a problem hiding this comment.
Do you think we should change the label in the admin UI?
There was a problem hiding this comment.
I think that "Percent Per Item" makes sense in the admin UI. I think I just wanted to note this in case someone was looking for "Percent on Line Item" in the admin and weren't finding it.
benjaminwil
force-pushed
the
promotion_calculators
branch
from
c857231 to
43f1af4
Compare
benjaminwil
force-pushed
the
promotion_calculators
branch
from
43f1af4 to
b19be58
Compare
Thanks to gmacdougall and kennyadsl for their reviews.
gmacdougall
approved these changes
Apr 17, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request extends my previous pull request for calculators documentation (#2511).
This is part a larger project to improve Solidus's documentation. See this gist with the high-level table of contents. Where and how this documentation will exist is still up for discussion.