Simplified the requirements article #8142
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
Conversation
reference/requirements.rst
Outdated
| Required | ||
| -------- | ||
| Beware that PHP can define a different configuration for the command console and | ||
| the web server, so you need to check requirements in both. |
reference/requirements.rst
Outdated
|
|
||
| .. caution:: | ||
| Browse the ``web/config.php`` file in your browser and fix the reported issues. | ||
| When using the PHP built-in web server, this file is available at |
There was a problem hiding this comment.
Just spotted this one: talking about the built-in web server here IMO does not make sense. The built-in web server is started using the same configuration that is used when running the CLI check below. So that's just doing work twice. What is actually important is that you perform the check using your "real" web server setup (so most likely Nginx or Apache).
There was a problem hiding this comment.
You are so right! I'm sorry about this mistake. I've removed this and reworded other parts. Thanks!
|
Thank you @javiereguiluz. |
This PR was squashed before being merged into the 2.7 branch (closes #8142). Discussion ---------- Simplified the requirements article Explaining the full list of requirements is not very smart, because we have a Requirement Checker that does that and it's hard to keep the doc in sync with that tool. I propose to simplify this article to only mention the specific PHP version required by Symfony and then explain how to check the other requirements. If you agree with this, I'll make the PRs for the other maintained Symfony versions. If this is merged, we can then simplify the installation article even more (removing this section: "Checking Symfony Requirements" -> https://github.com/symfony/symfony-docs/pull/8135/files#diff-1ef3833b924d9500d8baaa4bfa9fdb68R84) Commits ------- 05c8b06 Simplified the requirements article
Explaining the full list of requirements is not very smart, because we have a Requirement Checker that does that and it's hard to keep the doc in sync with that tool.
I propose to simplify this article to only mention the specific PHP version required by Symfony and then explain how to check the other requirements.
If you agree with this, I'll make the PRs for the other maintained Symfony versions. If this is merged, we can then simplify the installation article even more (removing this section: "Checking Symfony Requirements" -> https://github.com/symfony/symfony-docs/pull/8135/files#diff-1ef3833b924d9500d8baaa4bfa9fdb68R84)