Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add initial RMA and return authorization documentation #2540

Merged

Conversation

benjaminwil
Copy link
Contributor

@benjaminwil benjaminwil commented Jan 30, 2018

This pull request adds stub articles for Spree::InventoryUnits and Spree::ReturnAuthorizations. The return authorizations article introduces the concept of RMAs but not the larger returns/reimbursements system in Solidus, which will come later as its own section.

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.

Copy link
Member

@kennyadsl kennyadsl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just left a not on InventoryUnit attributes. It looks like a great starting point

`on_hand`, `backordered`, `shipped`, or `returned`.
- `variant_id`: The ID for the `Spree::Variant` corresponding with the inventory
unit that has been sold.
- `order_id`: The ID for the `Spree::Order` associated with the current
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if it's worth specifying that this attribute is no more on the Inventory Unit but it's calculated from the associated shipment of the Inventory Unit.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for pointing this out! For now, I will simply remove this item from the list.

@benjaminwil benjaminwil force-pushed the rma_inventoryunits_documentation branch from 075179c to d023307 Compare February 2, 2018 22:09
This commit adds a short article describing RMAs. In the future, it
might make sense to move this to a `../returns` section of the
documentation.
@jhawthorn jhawthorn merged commit 2fcabc9 into solidusio:master Feb 6, 2018
@benjaminwil benjaminwil deleted the rma_inventoryunits_documentation branch April 30, 2018 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants