Add third column to specific emplacements table describing relationship #5559
Conversation
The standard Symfony2 framework has mandatory requirements about specific emplacements, and then others that are considered best practice by convention. This commit makes the documentation clearer in order to provide a developer with reasonable expectations about the consequences of altering the default directory structure. Additionally, newer developers may be less intimidated and concerned by whether they are compromising any auto-wiring functionality by deviating from the information provided.
|
👍 thank you @rcousens. The only thing that I don't like is the column title ( |
|
Sure thing, I also think it could use a little extra padding as it looks a bit cramped! Will wait for feedback and make the final changes then. Quick question, presume max line length is 80? Table is currently @ 79. |
| Web Resources (CSS, JS, images) ``Resources/public/`` Mandatory | ||
| Translation files ``Resources/translations/`` Mandatory | ||
| Templates ``Resources/views/`` Mandatory | ||
| Unit and Functional Tests ``Tests/`` Convention |
There was a problem hiding this comment.
in some degree, this is mandatory too (as it's configured in the phpunit config file).
Renamed Relationship column to Location and updated value for Tests to Mandatory due to default phpunit config.
|
Updated as per feedback |
|
@wouterj I fixed up the spacing :) All good! Thank you for letting me improve the documentation, I remember starting with Symfony2 almost three years ago now and the amount of internal anxiety I had over "specific emplacements" made me hesitant to structure bundles in a way that best expressed the domain. Knowing what is mandatory and what is optional is somewhat liberating when you finally work it out. Cheers 👍 |
|
Hm, thinking about this using only "Location" sounds weird to me. I would prefer "Location Type" or something like that instead. |
| Web Resources (CSS, JS, images) ``Resources/public/`` Mandatory | ||
| Translation files ``Resources/translations/`` Mandatory | ||
| Templates ``Resources/views/`` Mandatory | ||
| Unit and Functional Tests ``Tests/`` Mandatory |
There was a problem hiding this comment.
this is not really mandatory. It is perfectly fine to put them elsewhere (even outside the prod code of your bundle) as long as you configure your testing tool accordingly (and it is perfectly fine to use another tool than PHPUnit, in which case tests would be elsewhere)
|
I will get this fixed up again this weekend. Cheers. Any preference on the third column header name? Location vs Location Type? |
|
Personally, I find the values of the last column too long. I propose to change it to use
Or leave the column empty, unless it is a convention:
Maybe even removing the complete column and adding a new footnote for the conventions (like the |
…elements (rcousens, javiereguiluz) This PR was submitted for the master branch but it was merged into the 2.7 branch instead (closes #6616). Discussion ---------- Better explain the mandatory/convention location of some elements This finishes #5559 by implementing the comments made by @wouterj Commits ------- eee4750 Fixed some wrong explanations 4a2c92f Tweaked the table contents cd0b889 Fix spacing on third column b853e52 Fix as per comments 99da972 Add third column to specific emplacements table describing relationship
The standard Symfony2 framework has mandatory requirements about specific emplacements, and then others that are considered best practice by convention. This commit makes the documentation clearer in order to provide a developer with reasonable expectations about the consequences of altering the default directory structure. Additionally, newer developers may be less intimidated and concerned by whether they are compromising any auto-wiring functionality by deviating from the information provided.
Fixes #5502