Skip to content

Updated main configuration guide to Flex #8588

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
wants to merge 2 commits into from

Conversation

wouterj
Copy link
Member

@wouterj wouterj commented Nov 3, 2017

No description provided.

@wouterj wouterj added this to the 4.0 milestone Nov 3, 2017
@wouterj wouterj requested a review from weaverryan November 3, 2017 14:37
Copy link
Member

@javiereguiluz javiereguiluz left a comment

Choose a reason for hiding this comment

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

Nice changes here! Thanks Wouter.


However, a ``.env.dist`` file *is* committed (with dummy values). This file
isn't read by Symfony: it's just a reference so that Symfony knows which
parameters need to be defined in the ``.env.dist`` file. If you add or remove
Copy link
Member

Choose a reason for hiding this comment

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

need to be defined in the ``.env.dist`` file -> need to be defined in the ``.env`` file ?


The main configuration file is called ``config.yml``:
The configuration for a package can be found in ``config/packages``. For
Copy link
Member

Choose a reason for hiding this comment

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

can be found in config/packages --> can be found in config/packages/ please always add a trailing slash when referencing directories so the reader never wonders if it's a dir or a file without extension. Thanks!


The main configuration file is called ``config.yml``:
The configuration for a package can be found in ``config/packages/``. For
Copy link
Member

Choose a reason for hiding this comment

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

for each package...

The configuration has some special top-level keys. One of them is called
``parameters``: it's used to define *variables* that can be referenced in *any*
other configuration file. For example, when installing the *translation*
package, ``config/services.yaml`` defines a ``locale`` parameter:
Copy link
Member

Choose a reason for hiding this comment

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

How about:

For example, when you install the translation package, a locale parameter is added to config/services.yaml:


However, a ``.env.dist`` file *is* committed (with dummy values). This file
isn't read by Symfony: it's just a reference so that Symfony knows which
parameters need to be defined in the ``.env.dist`` file. If you add or remove
Copy link
Member

Choose a reason for hiding this comment

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

parameters -> variables (to make it a bit clear that these aren't parameters)

However, a ``.env.dist`` file *is* committed (with dummy values). This file
isn't read by Symfony: it's just a reference so that Symfony knows which
parameters need to be defined in the ``.env.dist`` file. If you add or remove
keys to ``.env``, add or remove them from ``.env`` too, so both files are
Copy link
Member

Choose a reason for hiding this comment

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

the second should be .env.dist.

@wouterj
Copy link
Member Author

wouterj commented Nov 12, 2017

Ready to merge!

@weaverryan
Copy link
Member

Wooo! Thank you for this BIG pr Wouter!

weaverryan added a commit that referenced this pull request Nov 24, 2017
…iluz, weaverryan)

This PR was merged into the 4.0 branch.

Discussion
----------

Updated the best practice article about config

This was the only remaining article to be updated in "Best Practices".

Related to this:

* The main config.rst is being updated in ~~#8588~~
* Some config/* articles are being updated in ~~#8647~~.
* I'm going to update the rest of config/* articles.

Commits
-------

175a4e8 minor tweaks
b973f0c Updated the best practice article about config
weaverryan added a commit that referenced this pull request Dec 1, 2017
This PR was squashed before being merged into the 4.0 branch (closes #8592).

Discussion
----------

[Flex] Update routing & controller chapters

More progress in updating all of the "Getting Started" guides. I will next do templating, configuration (though this has been done in #8588) and also `service_container`, which I'd like to move into Getting Started.

Commits
-------

0cbbc28 fixing build errors
7f0163a tweaks
10563a9 Proofing the controller chapters
44f2ff8 more work on getting started docs
218e2d4 WIP controller chapter
8b923e6 WIP controller changes
89d56ea Updating routing for Flex
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants