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

[WIP][Documentation] Customizing credit memo model itself #12492

Closed
wants to merge 1 commit into from

Conversation

pamil
Copy link
Contributor

@pamil pamil commented Mar 30, 2021

Basic customization of RefundPlugin templates.

@pamil pamil requested a review from a team as a code owner March 30, 2021 07:30
@probot-autolabeler probot-autolabeler bot added the Documentation Documentation related issues and PRs - requests, fixes, proposals. label Mar 30, 2021
Copy link
Member

@GSadee GSadee left a comment

Choose a reason for hiding this comment

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

I am wondering about the last example, shouldn't we describe the overriding credit memo by adding some extra field to this entity instead of rendering extra data from the different controller? 🤔

Copy link
Member

@CoderMaggie CoderMaggie left a comment

Choose a reason for hiding this comment

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

Cool, however, I do agree with @GSadee's comment.

Custom background colors
------------------------

The first exemplary customization is to change background color of the heading of line items table.
Copy link
Member

Choose a reason for hiding this comment

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

Shall we add some screenshots here?

docs/cookbook/payments/customizing-credit-memo.rst Outdated Show resolved Hide resolved
docs/cookbook/payments/customizing-credit-memo.rst Outdated Show resolved Hide resolved
docs/cookbook/payments/customizing-credit-memo.rst Outdated Show resolved Hide resolved
docs/cookbook/payments/customizing-credit-memo.rst Outdated Show resolved Hide resolved
docs/cookbook/payments/customizing-credit-memo.rst Outdated Show resolved Hide resolved
@pamil
Copy link
Contributor Author

pamil commented Mar 30, 2021

There's an issue with overriding an entity - it does not work currently: Sylius/RefundPlugin#278

@pamil
Copy link
Contributor Author

pamil commented Mar 30, 2021

Anyway, I've prepared docs in case the linked issue is fixed - the last commit includes them. If not, we can still go with the first version, which is included in the first commit.

GSadee added a commit that referenced this pull request Mar 31, 2021
This PR was merged into the 1.9 branch.

Discussion
----------

| Q               | A
| --------------- | -----
| Branch?         | master
| Bug fix?        | no
| New feature?    | no
| BC breaks?      | no
| Deprecations?   | no
| Related tickets | part one of @pamil's pr #12492
| License         | MIT

<!--
 - Bug fixes must be submitted against the 1.7 or 1.8 branch (the lowest possible)
 - Features and deprecations must be submitted against the master branch
 - Make sure that the correct base branch is set

 To be sure you are not breaking any Backward Compatibilities, check the documentation:
 https://docs.sylius.com/en/latest/book/organization/backward-compatibility-promise.html
-->


Commits
-------

7d55aca [Documentation] Customizing credit memo
@GSadee GSadee changed the title [Documentation] Customizing credit memo [WIP][Documentation] Customizing credit memo model itself Mar 31, 2021
@GSadee GSadee changed the base branch from master to 1.9 March 31, 2021 11:50
@GSadee
Copy link
Member

GSadee commented Mar 31, 2021

The base of this pull-request was changed, you need fetch and reset your local branch
if you want to add new commits to this pull request. Reset before you pull, else commits
may become messed-up.

Unless you added new commits (to this branch) locally that you did not push yet,
execute git fetch origin && git reset "customizing-credit-memo" to update your local branch.

Feel free to ask for assistance when you get stuck 👍

@pamil pamil closed this May 4, 2021
@pamil pamil deleted the customizing-credit-memo branch May 4, 2021 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation related issues and PRs - requests, fixes, proposals.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants