[Docs] How to find out the resource config required when customizing models#10371
Conversation
| ---------------------------- ------------------------------------------- | ||
|
|
||
|
|
||
| In some cases however, you will see an error: |
There was a problem hiding this comment.
I would vote to add something like this to separate header.
There was a problem hiding this comment.
I was absolutely thinking the same thing, but what to call this?
It seems very related to "extended" models (https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/reference/inheritance-mapping.html#class-table-inheritance ?), but how can we explain or easily find out if that is the case for the model that the developer wants to customize?
Another option could be to add a "Troubleshooting" section for example, would you be okay with that?
There was a problem hiding this comment.
Troubleshooting seems reasonable for me, but this is a @CoderMaggie call :)
CoderMaggie
left a comment
There was a problem hiding this comment.
Hello Youri 👋
This tip is very valuable, although it's description is lengthy, don't you think? 😉
I suggest you to refactor this and:
- add a new doc (
Tips & Tricks) to the Customization Guide sectiondocs/customization/tips_and_tricks.rst; - In this doc add a section
How to get Sylius Resource configuration from the container? - And there give the tips you are giving here
- Here in the models doc you can then refer to that part from a
.. tip:::)
How do you feel about it?
Hi Magdalena, Thank you very much for your feedback. I really appreciate it. :D I feel at some point in time we should somehow edit the original model customization guide and introduce a step 1 that allows the reader to determine what kind of model they are trying to customize and immediately point them to the right section (so having separate instructions for each case, like we have a section for regular models and a section for translated models now). |
|
@CoderMaggie Can you review this again please? Thanks in advance! |
|
@4c0n thanks for your patience! Merging this PR as soon as the build passes 🎉 |
|
Thanks, Youri! 🎉 |
|
At your service Kamil 👍 |
Added information/instructions on how to find out what the correct resource configuration should be in
_sylius.yaml.