Skip to content

[DX] Quick entry about parameters.yml and parameters.yml.dist #4174

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

Closed
weaverryan opened this issue Aug 23, 2014 · 8 comments
Closed

[DX] Quick entry about parameters.yml and parameters.yml.dist #4174

weaverryan opened this issue Aug 23, 2014 · 8 comments
Labels
actionable Clear and specific issues ready for anyone to take them. DX

Comments

@weaverryan
Copy link
Member

I just realized that we don't directly explain parameters.yml and parameters.yml.dist anywhere. Heck, I think we barely explain the significance of parameters.yml.

I would like to add a small entry talking about these and also what to expect with the Incenteev ParameterHandler. Then, we could link to this from inside the parameters.yml and parameters.yml.dist files in the SE.

See also symfony/symfony-standard#701

@weaverryan weaverryan added the DX label Aug 23, 2014
fabpot added a commit to symfony/symfony-standard that referenced this issue Oct 6, 2014
…little (weaverryan)

This PR was squashed before being merged into the 2.3 branch (closes #701).

Discussion
----------

[WIP] Adding a quick note explaining paramters.yml.dist a little

Hi guys!

This is really simple, but a WIP because I also want to add an additional link at the top to symfony/symfony-docs#4174 after it's created.

Thanks!

Commits
-------

2f58ce7 [WIP] Adding a quick note explaining paramters.yml.dist a little
@cezar77
Copy link

cezar77 commented Nov 1, 2014

The file name parameters.yml.dist is wrongly spelled in the title. Please forgive me if I'm to pedantic, but it would be nice, if the title could be corrected.

@xabbuh xabbuh changed the title [DX] Quick entry about parameters.yml and paramters.yml.dist [DX] Quick entry about parameters.yml and parameters.yml.dist Nov 1, 2014
@xabbuh
Copy link
Member

xabbuh commented Nov 1, 2014

@cezar77 You're right. Thanks for noticing. :)

@javiereguiluz
Copy link
Member

If you could provide me an outline of the things to explain, I could take care of this. Thanks.

@weaverryan
Copy link
Member Author

@javiereguiluz I'm not totally sure. But, if you google for "symfony configuration", you only get back results for the Config component and other things. There is no "Symfony Framework Configuration" article that explains config.yml, config_dev.yml, parameters.yml, etc - though this article (http://symfony.com/doc/current/cookbook/configuration/environments.html) is related.

I want:

  1. A single "How to Configure Symfony" entry
  2. It has a section explaining very basically that config.yml let's you configure bundles - with a link to the reference section
  3. It has a section explaining parameters.yml, parameters.yml.dist and what do expect with Incenteev
  4. It has a quick section explaining the config_dev.yml files and how you can use them to tweak settings in the environments. Then a link to the full environments section.

I would appreciate any 👍 or 👎 feedback on this idea. It makes sense to me, but I don't want to create work if others don't think it's necessary.

Thanks!

@javiereguiluz
Copy link
Member

@weaverryan I like your idea a lot ... and I have two additional suggestions:

  • What about mentioning some information about using environment variables for configuration. I find this technique very common when deploying applications.
  • Related to the previous item: we should explain "the one true way" of configuring very sensitive configuration options, such as the database credentials.

@weaverryan
Copy link
Member Author

@javiereguiluz good idea! It'll be the well-rounded entry on "how to configure" in general

@wouterj
Copy link
Member

wouterj commented May 1, 2015

👍

@javiereguiluz
Copy link
Member

I'm closing this as "won't fix" because these files are not needed when using Symfony Flex and they will be removed fro Symfony 4, which will be release in just a few months. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actionable Clear and specific issues ready for anyone to take them. DX
Projects
None yet
Development

No branches or pull requests

5 participants