Skip to content

[Setup] Clarify the Symfony binary and show small PHP built-in command #13475

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

Merged
merged 1 commit into from
Apr 3, 2020

Conversation

wouterj
Copy link
Member

@wouterj wouterj commented Apr 1, 2020

@MaikB on Reddit left some very usefull insights in how we documented Symfony CLI (ref). An excerpt from the comment:

First there is the docs. [...] They just push very hard towards the symfony-cli. That on its own is no big deal. A big deal is that I had to do some digging to even find out that this CLI is closed source. You have to mention that upfront. [... shows the steps it required to find out the source is closed]

Just give people an page which discusses the usage of the built-in web server (php -S localhost:8000 -t public), with or without a router script. Explain the shortcomings which lead you to develop the now deprecated symfony/web-server-bundle. Then tell the story of how the CLI came about and how it is connected to your cloud business. Tell us that you have to keep the sources closed for now, maybe because it contains details which are important for your business to be keep out of the public. Just give us something.

I sincerely do believe this is an communication issue. [...]

Now that I explained myself in more detail, let me say that I am thankful to Fabien and and everyone who has and still is working on Symfony. This is just a problem, not the end of the world. I hope you have a good day, given the pandemic, and stay safe.


I think this is very usefull information. I personally don't think there is anything wrong with the binary being closed source, but obviously there are people that feel uneasy about it. As we're an inclusive community, I think it makes sense to tell people upfront "hey, this is a closed source tool".
This effectively changes nothing, but would solve part of the problem of these people that now feel excluded. It also opens the possibility to point people to a location to report bugs in the binary (previously, we only mentioned it in the Local web server guide).

I was against documenting the PHP built-in server in the docs, to not make it more complicated. But as it's used by community members and just a very small one-liner, I think it's nice to have a small note about it. Again, it's a small note, but it potentially solves a huge thing for others.


@fabpot @nicolas-grekas @javiereguiluz @weaverryan As I'm totally not into all strategy and ideas behind Symfony, I would like your opinions/reviews here. The goal at the very minimal is to not upset people with the changes in this PR.

@wouterj wouterj added this to the 4.4 milestone Apr 1, 2020
@wouterj wouterj force-pushed the setup/mention-closed-source branch from b309c53 to 65cd6c9 Compare April 2, 2020 13:35
@javiereguiluz javiereguiluz changed the title [Setup] Clearify the Symfony binary and show small PHP built-in command [Setup] Clarify the Symfony binary and show small PHP built-in command Apr 3, 2020
@javiereguiluz javiereguiluz force-pushed the setup/mention-closed-source branch from 65cd6c9 to c571179 Compare April 3, 2020 06:58
@javiereguiluz
Copy link
Member

Thanks Wouter.

@javiereguiluz javiereguiluz merged commit 1a3f107 into symfony:4.4 Apr 3, 2020
@wouterj wouterj deleted the setup/mention-closed-source branch April 3, 2020 09:28
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.

6 participants