[RFR] Added "How to Organize Configuration Files" cookbook #3885
Conversation
javiereguiluz
changed the title
|
|
||
| # app/config/config.yml | ||
| imports: | ||
| - { resource: 'bundles/' } |
|
Great job! I'm thinking about writing some articles about how to migrate from the standard SE to a fully custom SE. I think this is a great start of that idea! I'll review it later this week. |
| @@ -0,0 +1,258 @@ | |||
| .. index:: | |||
| single: Configuration, Environments | |||
There was a problem hiding this comment.
I don't think we want to refer people to this article in the "Environments" index, do we?
|
This article should also be added to |
| ├─ vendor/ | ||
| └─ web/ | ||
|
|
||
| This default structure was choosen for its simplicity — one file per environment. |
javiereguiluz
changed the title
javiereguiluz
changed the title
| } | ||
|
|
||
| Following the same technique explained in the previous section, make sure to | ||
| load the appropriate configuration files from each main file (``common.yml``, |
There was a problem hiding this comment.
load -> import to be consistent with the terms used in the code?
| .. code-block:: text | ||
|
|
||
| <your-project>/ | ||
| ├─ app/ |
There was a problem hiding this comment.
we could also remove the /'s since anything that lacks extension is a folder? although some executables lack extension
There was a problem hiding this comment.
I think including the slash makes things easier to understand
There was a problem hiding this comment.
👍 For keeping the slash for readability reasons.
There was a problem hiding this comment.
👍 as well. Not all files have an extension (app/console for instance, even if it does not appear in this tree)
|
good job 👍 |
|
@cordoval, thanks for your review. I have included all your suggestions except these ones because I don't know what does the style guide say about them: Regarding the |
| file to execute your own logic. In addition, you can define your own services | ||
| to load configuration from databases and web services. | ||
|
|
||
| Directory Loading |
There was a problem hiding this comment.
Does directory loading really works out of the box ? I don't see anything about it in the codebase. Are you using a thrid-party bundle for that ?
There was a problem hiding this comment.
@stof you are right. Thanks for noticing this. I was confused by the resource loading of the Config component and the fact that this correctly works for loading routes defined as annotations in one or more controllers inside a bundle.
I've just removed this section.
There was a problem hiding this comment.
I suggest you open a feature request on Symfony for this. It looks useful (in case you don't need to strictly control the order of loading)
There was a problem hiding this comment.
@javiereguiluz, I did a PR about Directory Loading, if you want to take a look: symfony/symfony#11059
| { | ||
| // ... | ||
|
|
||
| public function registerContainerConfiguration(LoaderInterface $loader) |
There was a problem hiding this comment.
Either a use statement for the LoaderInterface or // ... should be added to the top of the file.
There was a problem hiding this comment.
The same applies to the Kernel class.
|
This reads great! It fell of my radar, but we've added some new labels to track finished PR's (Wouter did all the work), which makes finished PR's easier to focus on. Progress! Thanks! |
…ook (javiereguiluz) This PR was merged into the 2.3 branch. Discussion ---------- [RFR] Added "How to Organize Configuration Files" cookbook | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes | Applies to | 2.3+ | Fixed tickets | #3680 This is just the first draft of a new cookbook. Please, tell me anything that I should add, change or remove. Thanks! Commits ------- 4241ee5 Removed redundant configuration blocks 68a7d2a Added more suggestions made by @xabbuh be414e0 Removed the "Directory Loading" section because it doesn't work out of the box da3e1d0 Fixed the target of one cookbook article link af5d478 Added suggestions made by @cordoval 4a87cfb Fixed the link to another cookbook article 2a32b23 Added the latest suggestions made by reviewers d861be3 Added all the suggestions made by reviewers 0520bf1 Firest draft of the "How to Organize Configuration Files" cookbook
This is just the first draft of a new cookbook. Please, tell me anything that I should add, change or remove. Thanks!